pkgmaker: Package development utilities

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-09-25 12:32:20
MaintainerRenaud Gaujoux <renaud@tx.technion.ac.il>
LicenseGPL (>=2)
Version0.25.8
https://renozao.github.io/pkgmaker

View on R-Forge

Man pages

add_lib: Adding Package Libraries

addnames: Generating Names

addToLogger: Enhancing RUnit Logger

alphacol: Colour utilities

askUser: User Queries

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

dot-silenceF: Silencing Functions

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

inSweave: Identifying Sweave Run

irequire: Require a Package with User Interaction

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

packageExtra: Install/Run Extra Things After Standard Package Installation

packageReference: Package References

packages: Loading Packages

packageTestEnv: Returns the package internal environment where unit tests are...

parsePackageCitation: Formatting Package Citations in Sweave/knitr Documents

pkgmaker-defunct: Defunct Functions in pkgmaker

pkgmaker-deprecated: Deprecated 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

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

userData: User Data Directory

userIs: Checking R User

utest: Running Unit Tests

utestFramework: Inferring Unit Test Framework

utestPath: Unit Tests Result Directory

vignette: Identifies Manually Run Vignettes

winbuild: Build a Windows Binary Package

write.pkgbib: Generate a Bibtex File from Package Citations

writeUnitVignette: Writes Unit Tests Vignette

Functions

add_lib Man page
addnames Man page
addnames.array Man page
addnames.default Man page
addnames.matrix Man page
addNamespaceExport Man page
addnames.vector Man page
addToLogger Man page
allFormals Man page
alphacol Man page
askUser Man page
as_package Man page
as.package_options Man page
as.rnw Man page
attr_mode Man page
attr_mode<- Man page
cgetAnywhere Man page
checkPlot Man page
checkWarning Man page
citecmd Man page
cite_pkg Man page
CLIArgumentParser Man page
compactVignettes Man page
compile_src Man page
CRAN Man page
exitCheck Man page
expand_dots Man page
expand_list Man page
ExposeAttribute Man page
extractLocalFun Man page
file_extension Man page
fix_registry Man page
getBiocMirror Man page
getBiocRepos Man page
getLoadingNamespace Man page
graphics-utils Man page
hasArg2 Man page
hasEnvar Man page
hasNames Man page
hasPackageRegistry Man page
hook_backspace Man page
hook_toggle Man page
hook_try Man page
install.extrapackages Man page
install.extras Man page
inSweave Man page
irequire Man page
isCHECK Man page
isCRANcheck Man page
isCRAN_timing Man page
isDevNamespace Man page
is.dir Man page
isFALSE Man page
is.file Man page
isInteger Man page
isLoadingNamespace Man page
isManualVignette Man page
is_NA Man page
isNamespaceLoaded Man page
isNumber Man page
is_option_symlink Man page
isPackageInstalled Man page
isReal Man page
is_something Man page
isString Man page
is.verbose Man page
knit_ex Man page
latex_bibliography Man page
latex_preamble Man page
ldata Man page
libname Man page
list.libs Man page
listPackageOptions Man page
lmessage Man page
lsilent Man page
lverbose Man page
makeFakeVignette Man page
makeUnitVignette Man page
mfrow Man page
mkoptions Man page
mrequire Man page
new2 Man page
ns_get Man page
oneoffVariable Man page
onLoad Man page
onUnload Man page
.options Man page
option_symlink Man page
option_symlink_target Man page
orderVersion Man page
packageCLI Man page
packageData Man page
packageEnv Man page
packageExtra Man page
packageExtraHandler Man page
packageExtraRunner Man page
.packageMetaRegistry Man page
packageName Man page
[[.package_options Man page
packageOptions Man page
packagePath Man page
packageReference Man page
packageReferenceFile Man page
packageRegistries Man page
packageRegistry Man page
packageTestEnv Man page
parseCMD Man page
parsePackageCitation Man page
pkgmaker-defunct Man page
pkgmaker-deprecated Man page
pkgreg_fetch Man page
pkgreg_remove Man page
postponeAction Man page
qlibrary Man page
qrequire Man page
quickinstall Man page
R.CMD Man page
RdSection2latex Man page
regfetch Man page
requirePackage Man page
require.quiet Man page
requireRUnit Man page
R.exec Man page
rnw Man page
rnwChildren Man page
rnwCompiler Man page
rnwDriver Man page
rnwIncludes Man page
rnwWrapper Man page
R.SHLIB Man page
runPostponedAction Man page
Rversion Man page
setBiocMirror Man page
setClassRegistry Man page
setCRANMirror Man page
setPackageExtra Man page
setPackageExtraHandler Man page
setPackageRegistry Man page
setPackageRegistryEntry Man page
setupPackageOptions Man page
.silenceF Man page
simpleRegistry Man page
sortVersion Man page
source_files Man page
str_bs Man page
str_desc Man page
str_diff Man page
str_fun Man page
str_ns Man page
str_out Man page
sVariable Man page
Sys.getenv_value Man page
testRversion Man page
topns Man page
topns_name Man page
unit.test Man page
userData Man page
userIs Man page
utest Man page
utest,character-method Man page
utestFramework Man page
utest,function-method Man page
utest-methods Man page
utestPath Man page
utest,RUnitTestSuite-method Man page
vignetteMakefile Man page
vmessage Man page
winbuild Man page
write.bib Man page
write.pkgbib Man page
writeUnitVignette Man page

Files

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

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

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

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