Package development utilities


[Up] [Top]

Documentation for package ‘pkgmaker’ version 0.22

Help Pages

A C E F G H I K L M N O P Q R S T U V W misc

-- A --

addnames Generating Names
addnames.array Generating Names
addnames.default Generating Names
addnames.matrix Generating Names
addnames.vector Generating Names
addNamespaceExport Namespace Development Functions
addToLogger Enhancing RUnit Logger
add_lib Adding Package Libraries
allFormals Extracting Local Function Definition
alphacol Colour utilities
as.package Package Development Utilities
as.package_options 'option_symlink' creates a symbolic link to option 'x'.
as.rnw Identifies Manually Run Vignettes
attr_mode Exposing Object Attributes
attr_mode<- Exposing Object Attributes

-- C --

cgetAnywhere Get Anywhere
checkWarning Extra Check Functions for RUnit
citecmd Citing Package References
CLIArgumentParser Enhanced Command Line Argument Parser
compactVignettes Identifies Manually Run Vignettes
compile_src Compile Source Files from a Development Package
CRAN Setting Mirrors and Repositories

-- E --

exitCheck Exit Error Checks
expand_dots Expanding Lists
expand_list Expanding Lists
ExposeAttribute Exposing Object Attributes
extractLocalFun Extracting Local Function Definition

-- F --

file_extension Extract File Extension

-- G --

getBiocMirror Setting Mirrors and Repositories
getBiocRepos Setting Mirrors and Repositories
getLoadingNamespace Namespace Development Functions
graphics-utils Utility Functions for Graphics

-- H --

hasArg2 Checking for Missing Arguments
hasEnvar Check Environment Variables
hasNames Testing Object Type
hasPackageRegistry Package Registry
hook_backspace Knitr Extensions
hook_toggle Knitr Extensions
hook_try Knitr Extensions

-- I --

install.dependencies Installing All Package Dependencies
install.extrapackages Install/Run Extra Things After Standard Package Installation
install.extras Install/Run Extra Things After Standard Package Installation
inSweave Identifying Sweave Run
is.dir Testing Object Type
is.file Testing Object Type
isCHECK Package Check Utils
isCRANcheck Package Check Utils
isCRAN_timing Package Check Utils
isDevNamespace Namespace Development Functions
isFALSE Testing Object Type
isInteger Testing Object Type
isLoadingNamespace Namespace Development Functions
isManualVignette Identifies Manually Run Vignettes
isNamespaceLoaded Namespace Development Functions
isNumber Testing Object Type
isPackageInstalled Package Development Utilities
isReal Testing Object Type
isString Testing Object Type
is_NA Testing Object Type
is_option_symlink 'option_symlink' creates a symbolic link to option 'x'.
is_something Testing Object Type

-- K --

knit_ex Knitr Extensions

-- L --

latex_bibliography LaTeX Utilities for Vignettes
latex_preamble LaTeX Utilities for Vignettes
ldata Loading Package Data
libname Library Files Utilities
list.libs Library Files Utilities
listPackageOptions 'option_symlink' creates a symbolic link to option 'x'.

-- M --

makeFakeVignette Generate a Fake Vignette
makeUnitVignette Make Vignette for Unit Tests
mfrow Utility Functions for Graphics
mkoptions Quick Option-like Feature

-- N --

new2 Alternative S4 Constructor
ns_get Namespace Development Functions

-- O --

oneoffVariable One-off Global Variables
onLoad Default Load/Unload Functions
onUnload Default Load/Unload Functions
option_symlink 'option_symlink' creates a symbolic link to option 'x'.
option_symlink_target 'option_symlink' creates a symbolic link to option 'x'.
orderVersion Ordering Version Numbers

-- P --

packageCLI Package Specific Command Line Interface
packageData Loading Package Data
packageDependencies List Package Dependencies
packageEnv Package Development Utilities
packageExtra Install/Run Extra Things After Standard Package Installation
packageExtraHandler Install/Run Extra Things After Standard Package Installation
packageExtraRunner Install/Run Extra Things After Standard Package Installation
packageName Package Development Utilities
packageOptions 'option_symlink' creates a symbolic link to option 'x'.
packagePath Package Development Utilities
packageReference Package References
packageReferenceFile Bibtex Utilities
packageRegistries Package Registry
packageRegistry Package Registry
packageTestEnv Returns the package internal environment where unit tests are stored.
parseCMD Enhanced Command Line Argument Parser
parsePackageCitation Formatting Package Citations in Sweave/knitr Documents
pkgmaker-defunct Defunct Functions in pkgmaker
pkgreg_fetch Finds an entry in a registry.
pkgreg_remove Finds an entry in a registry.
postponeAction Postponing Actions

-- Q --

quickinstall Quick Installation of a Source Package

-- R --

R.CMD Executing R Commands
R.exec Executing R Commands
R.SHLIB Executing R Commands
RdSection2latex Format Rd Sections into LatTeX
regfetch Finds an entry in a registry.
require.quiet Silent Require
requirePackage Require a Package
requireRUnit Load RUnit Compatible Package
rnw Identifies Manually Run Vignettes
rnwChildren Identifies Manually Run Vignettes
rnwCompiler Identifies Manually Run Vignettes
rnwDriver Identifies Manually Run Vignettes
rnwIncludes Identifies Manually Run Vignettes
rnwWrapper Identifies Manually Run Vignettes
runPostponedAction Postponing Actions
Rversion Complete R version

-- S --

setBiocMirror Setting Mirrors and Repositories
setClassRegistry Automatic S4 Class for Registry Entries
setCRANMirror Setting Mirrors and Repositories
setPackageExtra Install/Run Extra Things After Standard Package Installation
setPackageExtraHandler Install/Run Extra Things After Standard Package Installation
setPackageRegistry Package Registry
setPackageRegistryEntry Package Registry
setupPackageOptions Package Specific Options
simpleRegistry Simple Package Registry
sortVersion Ordering Version Numbers
source_files Source Multiple Files
str_bs Formatting Utilities
str_desc Formatting Utilities
str_diff Finding Differences Between Strings
str_fun Formatting Utilities
str_ns Package Development Utilities
str_out Formatting Utilities
sVariable Global Static Variable
Sys.getenv_value System Environment Variables

-- T --

testRversion Testing R Version
topns Package Development Utilities
topns_name Package Development Utilities

-- U --

unit.test Embedded Unit Tests
userIs Checking R User
utest Running Unit Tests
utest-method Running Unit Tests
utest-methods Running Unit Tests
utestFramework Inferring Unit Test Framework
utestPath Unit Tests Result Directory

-- V --

vignetteMakefile Identifies Manually Run Vignettes

-- W --

write.bib Defunct Functions in pkgmaker
write.pkgbib Generate a Bibtex File from Package Citations
writeUnitVignette Writes Unit Tests Vignette
write_PACKAGES_index Generate CRAN-like Repository Index

-- misc --

.options Quick Option-like Feature
[[.package_options 'option_symlink' creates a symbolic link to option 'x'.