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

Files in this package

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

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

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