pkgmaker: Package development utilities
Version 0.22

This package provides some low-level utilities to use for package development. It currently provides managers for multiple package specific options and registries, vignette, unit test and bibtex related utilities. It serves as a base package for packages like NMF, RcppOctave, doRNG, and as an incubator package for other general purposes utilities, that will eventually be packaged separately. It is still under heavy development and changes in the interface(s) are more than likely to happen.

AuthorRenaud Gaujoux
Date of publication2014-05-14 16:18:51
MaintainerRenaud Gaujoux <renaud@tx.technion.ac.il>
LicenseGPL (>= 2)
Version0.22
URL https://renozao.github.io/pkgmaker
Package repositoryView on CRAN
InstallationInstall the latest version of this package by entering the following in R:
install.packages("pkgmaker")

Popular man pages

add_lib: Adding Package Libraries
addToLogger: Enhancing RUnit Logger
bibtex: Bibtex Utilities
ExposeAttribute: Exposing Object Attributes
load: Default Load/Unload Functions
makeFakeVignette: Generate a Fake Vignette
quickinstall: Quick Installation of a Source Package
See all...

All man pages Function index File listing

Man pages

add_lib: Adding Package Libraries
addnames: Generating Names
addToLogger: Enhancing RUnit Logger
alphacol: Colour utilities
bibtex: Bibtex Utilities
cgetAnywhere: Get Anywhere
checkPlot: Plot in Unit Tests
citecmd: Citing Package References
cite_pkg: 'bibcite' provides an inline package citation functionnality....
CLIArgumentParser: Enhanced Command Line Argument Parser
compile_src: Compile Source Files from a Development Package
devutils: Package Development Utilities
dot-packageMetaRegistry: Creates or Retrieves a Package Meta Registry
exitCheck: Exit Error Checks
expand_list: Expanding Lists
ExposeAttribute: Exposing Object Attributes
file_extension: Extract File Extension
fix_registry: Fix Registry Access Functions
formals: Extracting Local Function Definition
graphics-utils: Utility Functions for Graphics
hasArg2: Checking for Missing Arguments
hasEnvar: Check Environment Variables
install.dependencies: Installing All Package Dependencies
inSweave: Identifying Sweave Run
isCRANcheck: Package Check Utils
is_something: Testing Object Type
knit_ex: Knitr Extensions
latex: LaTeX Utilities for Vignettes
libutils: Library Files Utilities
load: Default Load/Unload Functions
local-options: Quick Option-like Feature
lverbose: Internal verbosity option
makeFakeVignette: Generate a Fake Vignette
makeUnitVignette: Make Vignette for Unit Tests
mirrors: Setting Mirrors and Repositories
namespace: Namespace Development Functions
new2: Alternative S4 Constructor
oneoffVariable: One-off Global Variables
options: 'option_symlink' creates a symbolic link to option 'x'.
orderVersion: Ordering Version Numbers
packageCLI: Package Specific Command Line Interface
packageData: Loading Package Data
packageDependencies: List Package Dependencies
packageExtra: Install/Run Extra Things After Standard Package Installation
packageReference: Package References
packageTestEnv: Returns the package internal environment where unit tests are...
parsePackageCitation: Formatting Package Citations in Sweave/knitr Documents
pkgmaker-defunct: Defunct Functions in pkgmaker
postponeAction: Postponing Actions
quickinstall: Quick Installation of a Source Package
RdSection2latex: Format Rd Sections into LatTeX
regfetch: Finds an entry in a registry.
registry: Package Registry
requirePackage: Require a Package
require.quiet: Silent Require
requireRUnit: Load RUnit Compatible Package
R.exec: Executing R Commands
Rversion: Complete R version
setClassRegistry: Automatic S4 Class for Registry Entries
setupPackageOptions: Package Specific Options
simpleRegistry: Simple Package Registry
source_files: Source Multiple Files
str_diff: Finding Differences Between Strings
str_out: Formatting Utilities
sVariable: Global Static Variable
Sys.getenv_value: System Environment Variables
testRversion: Testing R Version
uchecks: Extra Check Functions for RUnit
unit.test: Embedded Unit Tests
userIs: Checking R User
utest: Running Unit Tests
utestFramework: Inferring Unit Test Framework
utestPath: Unit Tests Result Directory
vignette: Identifies Manually Run Vignettes
write_PACKAGES_index: Generate CRAN-like Repository Index
write.pkgbib: Generate a Bibtex File from Package Citations
writeUnitVignette: Writes Unit Tests Vignette

Functions

Files

inst
inst/vignette.mk
inst/tests
inst/tests/runit.utils.r
inst/tests/runit.options.r
inst/package.mk
inst/cleveref.sty
inst/doc
inst/doc/pkgmaker-unitTests.R
inst/doc/pkgmaker-unitTests.pdf
inst/doc/pkgmaker.Rnw
inst/doc/pkgmaker.pdf
inst/doc/pkgmaker.R
inst/doc/pkgmaker-unitTests.Rnw
tests
tests/doRUnit.R
NAMESPACE
R
R/repositories.R
R/utils.R
R/project.R
R/registry.R
R/graphics.R
R/colors.R
R/devutils.R
R/files.R
R/namespace.R
R/logging.R
R/unitTests.R
R/data.R
R/bibtex.R
R/package-extra.R
R/options.R
R/knitr.R
R/packages.R
R/is.R
R/rd.R
R/CLI.R
R/package.R
R/vignette.R
vignettes
vignettes/pkgmaker.Rnw
vignettes/pkgmaker-unitTests.Rnw
MD5
build
build/vignette.rds
DESCRIPTION
man
man/checkPlot.Rd
man/write_PACKAGES_index.Rd
man/knit_ex.Rd
man/userIs.Rd
man/utestFramework.Rd
man/devutils.Rd
man/requireRUnit.Rd
man/setupPackageOptions.Rd
man/str_out.Rd
man/vignette.Rd
man/RdSection2latex.Rd
man/compile_src.Rd
man/bibtex.Rd
man/local-options.Rd
man/postponeAction.Rd
man/cite_pkg.Rd
man/citecmd.Rd
man/fix_registry.Rd
man/file_extension.Rd
man/testRversion.Rd
man/new2.Rd
man/hasArg2.Rd
man/requirePackage.Rd
man/addnames.Rd
man/namespace.Rd
man/utestPath.Rd
man/writeUnitVignette.Rd
man/Rversion.Rd
man/mirrors.Rd
man/cgetAnywhere.Rd
man/packageReference.Rd
man/graphics-utils.Rd
man/formals.Rd
man/utest.Rd
man/unit.test.Rd
man/latex.Rd
man/require.quiet.Rd
man/options.Rd
man/orderVersion.Rd
man/libutils.Rd
man/Sys.getenv_value.Rd
man/isCRANcheck.Rd
man/packageExtra.Rd
man/quickinstall.Rd
man/sVariable.Rd
man/simpleRegistry.Rd
man/dot-packageMetaRegistry.Rd
man/setClassRegistry.Rd
man/addToLogger.Rd
man/registry.Rd
man/install.dependencies.Rd
man/lverbose.Rd
man/parsePackageCitation.Rd
man/pkgmaker-defunct.Rd
man/load.Rd
man/packageData.Rd
man/is_something.Rd
man/source_files.Rd
man/CLIArgumentParser.Rd
man/exitCheck.Rd
man/uchecks.Rd
man/packageTestEnv.Rd
man/regfetch.Rd
man/str_diff.Rd
man/ExposeAttribute.Rd
man/makeFakeVignette.Rd
man/write.pkgbib.Rd
man/R.exec.Rd
man/hasEnvar.Rd
man/packageDependencies.Rd
man/expand_list.Rd
man/oneoffVariable.Rd
man/makeUnitVignette.Rd
man/inSweave.Rd
man/add_lib.Rd
man/packageCLI.Rd
man/alphacol.Rd
pkgmaker documentation built on May 19, 2017, 9:52 a.m.

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.

Please suggest features or report bugs in the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.