Package development utilities

Introduction

The package pkgmaker provides implementeations of features commonly used when developing R packages:

• Package specific options, with the possibility of defining multiple subsets

• Multiple registries based on the registry package

• Unified environment/namespace access functions that work in both production mode (build/check/install) and development mode, when loading code with the package devtools.

The package pkgmaker is available from CRAN at http://cran.r-project.org/web/packages/pkgmaker. The development project is hosted on R-forge at http://r-forge.r-project.org/projects/pkgmaker/

Help topics

• add_lib
  Adding Package Libraries
• addnames(addnames.array, addnames.default, addnames.matrix, addnames.vector)
  Generating Names
• addToLogger
  Enhancing RUnit Logger
• alphacol
  Colour utilities
• cgetAnywhere
  Get Anywhere
• checkWarning
  Extra Check Functions for RUnit
• citecmd
  Citing Package References
• compile_src
  Compile Source Files from a Development Package
• exitCheck
  Exit Error Checks
• expand_list(expand_dots)
  Expanding Lists
• ExposeAttribute(attr_mode, attr_mode<-)
  Exposing Object Attributes
• extractLocalFun(allFormals)
  Extracting Local Function Definition
• file_extension
  Extract File Extension
• getLoadingNamespace(addNamespaceExport, isDevNamespace, isLoadingNamespace, isNamespaceLoaded)
  Namespace Development Functions
• graphics-utils(mfrow)
  Utility Functions for Graphics
• hasArg2
  Checking for Missing Arguments
• hasEnvar
  Check Environment Variables
• install.dependencies
  Installing All Package Dependencies
• inSweave
  Identifying Sweave Run
• isCRANcheck(isCHECK, isCRAN_timing)
  Package Check Utils
• is_something(hasNames, is.dir, isFALSE, is.file, isInteger, is_NA, isNumber, isReal, isString)
  Testing Object Type
• latex_preamble(latex_bibliography)
  LaTeX Utilities for Vignettes
• list.libs(libname)
  Library Files Utilities
• makeFakeVignette
  Generate a Fake Vignette
• makeUnitVignette
  Make Vignette for Unit Tests
• mkoptions(.options)
  Quick Option-like Feature
• new2
  Alternative S4 Constructor
• oneoffVariable
  One-off Global Variables
• onLoad(onUnload)
  Default Load/Unload Functions
• option_symlink(as.package_options, is_option_symlink, listPackageOptions, option_symlink_target, [[.package_options, packageOptions)
  option_symlink
• orderVersion(sortVersion)
  Ordering Version Numbers
• packageData(ldata)
  Loading Package Data
• packageEnv(as.package, isPackageInstalled, packageName, packagePath, str_ns, topns, topns_name)
  Package Development Utilities
• packageReference
  Package References
• packageReferenceFile
  Bibtex Utilities
• packageRegistry(hasPackageRegistry, packageRegistries, setPackageRegistry, setPackageRegistryEntry)
  Package Registry
• packageTestEnv
  Returns the package internal environment where unit tests are stored.
• postponeAction(runPostponedAction)
  Postponing Actions
• quickinstall
  Quick Installation of a Source Package
• regfetch(pkgreg_fetch, pkgreg_remove)
  Finds an entry in a registry.
• requirePackage
  Require a Package
• require.quiet
  Silent Require
• requireRUnit
  Load RUnit Compatible Package
• R.exec(R.CMD, R.SHLIB)
  Executing R Commands
• rnw(as.rnw, compactVignettes, rnwChildren, rnwCompiler, rnwDriver, rnwIncludes, rnwWrapper, vignetteMakefile)
  Utilities for Vignettes
• Rversion
  Complete R version
• setBiocMirror(CRAN, getBiocMirror, getBiocRepos, setCRANMirror)
  Setting Mirrors and Repositories
• setClassRegistry
  Automatic S4 Class for Registry Entries
• setPackageExtraHandler(install.extrapackages, install.extras, packageExtra, packageExtraHandler, packageExtraRunner, setPackageExtra)
  Install/Run Extra Things After Standard Package Installation
• setupPackageOptions
  Package Specific Options
• simpleRegistry
  Simple Package Registry
• source_files
  Source Multiple Files
• str_diff
  Finding Differences Between Strings
• str_out(str_desc, str_fun)
  Formatting Utilities
• sVariable
  Global Static Variable
• testRversion
  Testing R Version
• unit.test
  Embedded Unit Tests
• userIs
  Checking R User
• utest(utest,character-method, utest,function-method, utest-methods, utest,RUnitTestSuite-method)
  Running Unit Tests
• utestFramework
  Inferring Unit Test Framework
• utestPath
  Unit Tests Result Directory
• write.bib
  Generate a Bibtex File from Package Citations
• writeUnitVignette
  Writes Unit Tests Vignette