Development Utilities for R Packages
![[R logo]](../../../doc/html/Rlogo.svg)
![[Up]](../../../doc/html/left.jpg)
![[Top]](../../../doc/html/up.jpg)
Documentation for package ‘pkgmaker’ version 0.32.8
Help Pages
A B C D E F G H I K L M N O P Q R S T U V W misc
-- A --
| addnames | Generating Names |
| addnames.array | Generating Names |
| addnames.default | Generating Names |
| addnames.matrix | Generating Names |
| addnames.vector | Generating Names |
| addNamespaceExport | Namespace Development Functions |
| addToLogger | Enhancing RUnit Logger |
| add_lib | Adding Package Libraries |
| allFormals | Extracting Local Function Definition |
| alphacol | Colour utilities |
| as.package_options | 'option_symlink' creates a symbolic link to option 'x'. |
| as.rnw | Utilities for Vignettes |
| askUser | User Queries |
| as_package | Package Development Utilities |
| attr_mode | Exposing Object Attributes |
| attr_mode<- | Exposing Object Attributes |
-- B --
| bibtex | Bibtex Utilities |
-- C --
| cgetAnywhere | Get Anywhere |
| charmap | Substituting Strings Against a Mapping Table |
| checkWarning | Extra Check Functions for RUnit |
| citecmd | Citing Package References |
| compactVignettes | Utilities for Vignettes |
| compile_src | Compile Source Files from a Development Package |
| CRAN | Main CRAN Mirror URL |
-- D --
| digest_function | Compute Function Digest Hash |
-- E --
| exitCheck | Exit Error Checks |
| expand_dots | Expanding Lists |
| expand_list | Expanding Lists |
| ExposeAttribute | Exposing Object Attributes |
| extractLocalFun | Extracting Local Function Definition |
-- F --
| factor2character | Converting Factors to Character Vectors |
| file_extension | Extract File Extension |
| find_devpackage | Find Path to Development Package Root Directory |
-- G --
| getBiocMirror | Setting Mirrors and Repositories |
| getBiocRepos | Setting Mirrors and Repositories |
| getLoadingNamespace | Namespace Development Functions |
| gfile | Open a File Graphic Device |
| graphics-utils | Utility Functions for Graphics |
-- H --
| hasArg2 | Checking for Missing Arguments |
| hasEnvar | Check Environment Variables |
| hasNames | Testing Object Type |
| hasPackageRegistry | Package Registry |
| hook_backspace | Knitr Extensions |
| hook_toggle | Knitr Extensions |
| hook_try | Knitr Extensions |
-- I --
| install.extrapackages | Install/Run Extra Things After Standard Package Installation |
| install.extras | Install/Run Extra Things After Standard Package Installation |
| inSweave | Identifying Sweave Run |
| irequire | Require a Package with User Interaction |
| is.dir | Testing Object Type |
| is.file | Testing Object Type |
| is.verbose | Logging Feature |
| isCHECK | Package Check Utils |
| isCRANcheck | Package Check Utils |
| isCRAN_timing | Package Check Utils |
| isDevNamespace | Namespace Development Functions |
| isFALSE | Testing Object Type |
| isInteger | Testing Object Type |
| isLoadingNamespace | Namespace Development Functions |
| isManualVignette | Utilities for Vignettes |
| isNamespaceLoaded2 | Namespace Development Functions |
| isNumber | Testing Object Type |
| isPackageInstalled | Package Development Utilities |
| isReal | Testing Object Type |
| isString | Testing Object Type |
| is_NA | Testing Object Type |
| is_option_symlink | 'option_symlink' creates a symbolic link to option 'x'. |
| is_something | Testing Object Type |
| iterCount | Simple Text Iteration Counter |
-- K --
| knit_ex | Knitr Extensions |
-- L --
| latex_bibliography | LaTeX Utilities for Vignettes |
| latex_preamble | LaTeX Utilities for Vignettes |
| ldata | Loading Package Data |
| libname | Library Files Utilities |
| library_project | Load Development Package |
| list.data | List Package Data Objects |
| list.libs | Library Files Utilities |
| listPackageOptions | 'option_symlink' creates a symbolic link to option 'x'. |
| lmessage | Logging Feature |
| load_all_file | Generate a Loading Script for Development Packages |
| load_project | Load Development Package |
| log_append | Logging Feature |
| lsilent | Logging Feature |
| lverbose | Logging Feature |
-- M --
| makeFakeVignette | Generate a Fake Vignette |
| makeUnitVignette | Make Vignette for Unit Tests |
| make_vignette_auxfiles | Generate RMarkdown Vignette Axiliary Files |
| messagef | General Log Formating |
| mfrow | Utility Functions for Graphics |
| mkoptions | Quick Option-like Feature |
| mrequire | Loading Packages |
-- N --
| new2 | Alternative S4 Constructor |
| ns_get | Namespace Development Functions |
-- O --
| oneoffVariable | One-off Global Variables |
| onLoad | Default Load/Unload Functions |
| onUnload | Default Load/Unload Functions |
| option_symlink | 'option_symlink' creates a symbolic link to option 'x'. |
| option_symlink_target | 'option_symlink' creates a symbolic link to option 'x'. |
| orderVersion | Ordering Version Numbers |
-- P --
| packageData | Loading Package Data |
| packageEnv | Package Development Utilities |
| packageExtra | Install/Run Extra Things After Standard Package Installation |
| packageExtraHandler | Install/Run Extra Things After Standard Package Installation |
| packageExtraRunner | Install/Run Extra Things After Standard Package Installation |
| packageName | Package Development Utilities |
| packageOptions | 'option_symlink' creates a symbolic link to option 'x'. |
| packagePath | Package Development Utilities |
| packageReference | Package References |
| packageReferenceFile | Bibtex Utilities |
| packageRegistries | Package Registry |
| packageRegistry | Package Registry |
| packageTestEnv | Returns the package internal environment where unit tests are stored. |
| package_bibliography | Bibtex Utilities |
| parsePackageCitation | Formatting Package Citations in Sweave/knitr Documents |
| pkgmaker-defunct | Defunct Functions in pkgmaker |
| pkgmaker-deprecated | Deprecated Functions in pkgmaker |
| pkgreg_fetch | Finds an entry in a registry. |
| pkgreg_remove | Finds an entry in a registry. |
| postponeAction | Postponing Actions |
-- Q --
| qlibrary | Loading Packages |
| qrequire | Loading Packages |
| quickinstall | Quick Installation of a Source Package |
-- R --
| R.CMD | Executing R Commands |
| R.exec | Executing R Commands |
| R.SHLIB | Executing R Commands |
| RdSection2latex | Format Rd Sections into LatTeX |
| read.yaml_section | Reads YAML Options Embbeded into a File |
| regfetch | Finds an entry in a registry. |
| render_notes | Renders rmarkdown Documents Using User Default Options |
| reorder_columns | Reordering Columns |
| require.quiet | Loading Packages |
| requirePackage | Deprecated Functions in pkgmaker |
| requireRUnit | Load RUnit Compatible Package |
| rnw | Utilities for Vignettes |
| rnwChildren | Utilities for Vignettes |
| rnwCompiler | Utilities for Vignettes |
| rnwDriver | Utilities for Vignettes |
| rnwIncludes | Utilities for Vignettes |
| rnwWrapper | Utilities for Vignettes |
| runPostponedAction | Postponing Actions |
| runVignette | Compile a Vignette Object |
| Rversion | Complete R version |
-- S --
| setBiocMirror | Setting Mirrors and Repositories |
| setClassRegistry | Automatic S4 Class for Registry Entries |
| setCRANMirror | Setting Mirrors and Repositories |
| setPackageExtra | Install/Run Extra Things After Standard Package Installation |
| setPackageExtraHandler | Install/Run Extra Things After Standard Package Installation |
| setPackageRegistry | Package Registry |
| setPackageRegistryEntry | Package Registry |
| setupPackageOptions | Package Specific Options |
| simpleRegistry | Simple Package Registry |
| sortVersion | Ordering Version Numbers |
| source_files | Source Multiple Files |
| str_bs | Formatting Utilities |
| str_class | Formatting Utilities |
| str_desc | Formatting Utilities |
| str_diff | Finding Differences Between Strings |
| str_dim | Formatting Utilities |
| str_fun | Formatting Utilities |
| str_hash | Formatting Utilities |
| str_md5sum | Formatting Utilities |
| str_ns | Package Development Utilities |
| str_out | Formatting Utilities |
| str_pkg | Formatting Utilities |
| sVariable | Global Static Variable |
| sys.function_digest | System Call Stack Utilities |
| sys.function_frame | System Call Stack Utilities |
| sys.function_nframe | System Call Stack Utilities |
| Sys.getenv_value | System Environment Variables |
| sys.source_file | System Call Stack Utilities |
| sys_call_stack | System Call Stack Utilities |
-- T --
| testRversion | Testing R Version |
| topns | Package Development Utilities |
| topns_name | Package Development Utilities |
-- U --
| unit.test | Embedded Unit Tests |
| unlist_ | Flatten a List Conserving Names |
| unlist_with_sep | Flattens All List Levels Using Separated Names |
| userData | User Data Directory 'userData' returns the path to a local directory/file where package-related user data can be stored. Note that a base directory is *always* created if necessary (see details). |
| userIs | Checking R User |
| using_collate | Execute code in temporarily altered environment. |
| using_dir | Execute code in temporarily altered environment. |
| using_env | Execute code in temporarily altered environment. |
| using_envvar | Execute code in temporarily altered environment. |
| using_lib | Execute code in temporarily altered environment. |
| using_libpaths | Execute code in temporarily altered environment. |
| using_locale | Execute code in temporarily altered environment. |
| using_options | Execute code in temporarily altered environment. |
| using_par | Execute code in temporarily altered environment. |
| using_path | Execute code in temporarily altered environment. |
| using_something | Execute code in temporarily altered environment. |
| utest | Running Unit Tests |
| utest-method | Running Unit Tests |
| utestFramework | Inferring Unit Test Framework |
| utestPath | Unit Tests Result Directory |
-- V --
| vignetteMakefile | Utilities for Vignettes |
| vmessage | Logging Feature |
-- W --
| winbuild | Build a Windows Binary Package |
| wnote | General Log Formating |
| write.bib | Defunct Functions in pkgmaker |
| write.pkgbib | Generate a Bibtex File from Package Citations |
| writeUnitVignette | Writes Unit Tests Vignette |
-- misc --
| .options | Quick Option-like Feature |
| .silenceF | Silencing Functions |
| [[.package_options | 'option_symlink' creates a symbolic link to option 'x'. |