Learn R Programming

⚠️There's a newer version (0.32.10) of this package.Take me there.

pkgmaker (version 0.22)

Package development utilities

Description

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.

Copy Link

Version

Install

install.packages('pkgmaker')

Monthly Downloads

230

Version

0.22

License

GPL (>= 2)

Maintainer

Renaud Gaujoux

Last Published

May 14th, 2014

Functions in pkgmaker (0.22)

checkPlot

Plot in Unit Tests
addToLogger

Enhancing RUnit Logger
packageReferenceFile

Bibtex Utilities
add_lib

Adding Package Libraries
exitCheck

Exit Error Checks
extractLocalFun

Extracting Local Function Definition
.packageMetaRegistry

Creates or Retrieves a Package Meta Registry
fix_registry

Fix Registry Access Functions
packageEnv

Package Development Utilities
source_files

Source Multiple Files
pkgmaker-defunct

Defunct Functions in pkgmaker
R.exec

Executing R Commands
utest

Running Unit Tests
write.pkgbib

Generate a Bibtex File from Package Citations
parsePackageCitation

Formatting Package Citations in Sweave/knitr Documents
makeUnitVignette

Make Vignette for Unit Tests
simpleRegistry

Simple Package Registry
ExposeAttribute

Exposing Object Attributes
RdSection2latex

Format Rd Sections into LatTeX
regfetch

Finds an entry in a registry.
Sys.getenv_value

System Environment Variables
packageDependencies

List Package Dependencies
new2

Alternative S4 Constructor
option_symlink

option_symlink creates a symbolic link to option x.
setupPackageOptions

Package Specific Options
writeUnitVignette

Writes Unit Tests Vignette
require.quiet

Silent Require
list.libs

Library Files Utilities
packageCLI

Package Specific Command Line Interface
write_PACKAGES_index

Generate CRAN-like Repository Index
utestPath

Unit Tests Result Directory
knit_ex

Knitr Extensions
sVariable

Global Static Variable
inSweave

Identifying Sweave Run
cgetAnywhere

Get Anywhere
Rversion

Complete R version
compile_src

Compile Source Files from a Development Package
requireRUnit

Load RUnit Compatible Package
lverbose

Internal verbosity option
getLoadingNamespace

Namespace Development Functions
citecmd

Citing Package References
graphics-utils

Utility Functions for Graphics
unit.test

Embedded Unit Tests
setPackageExtraHandler

Install/Run Extra Things After Standard Package Installation
orderVersion

Ordering Version Numbers
isCRANcheck

Package Check Utils
expand_list

Expanding Lists
packageData

Loading Package Data
testRversion

Testing R Version
oneoffVariable

One-off Global Variables
postponeAction

Postponing Actions
str_out

Formatting Utilities
makeFakeVignette

Generate a Fake Vignette
isManualVignette

Identifies Manually Run Vignettes
CLIArgumentParser

Enhanced Command Line Argument Parser
onLoad

Default Load/Unload Functions
install.dependencies

Installing All Package Dependencies
str_diff

Finding Differences Between Strings
checkWarning

Extra Check Functions for RUnit
quickinstall

Quick Installation of a Source Package
packageRegistry

Package Registry
addnames

Generating Names
hasEnvar

Check Environment Variables
latex_preamble

LaTeX Utilities for Vignettes
cite_pkg

bibcite provides an inline package citation functionnality. Technically it adds a given Bibtex key to a cache that is used at the end of the document processing to generate a .bib file with all citation keys.
is_something

Testing Object Type
mkoptions

Quick Option-like Feature
alphacol

Colour utilities
requirePackage

Require a Package
file_extension

Extract File Extension
setClassRegistry

Automatic S4 Class for Registry Entries
packageReference

Package References
packageTestEnv

Returns the package internal environment where unit tests are stored.
hasArg2

Checking for Missing Arguments
setBiocMirror

Setting Mirrors and Repositories
utestFramework

Inferring Unit Test Framework
userIs

Checking R User