Learn R Programming

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

pkgmaker (version 0.31.1)

Development Utilities for R Packages

Description

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

182

Version

0.31.1

License

GPL (>= 2)

Maintainer

Renaud Gaujoux

Last Published

March 19th, 2020

Functions in pkgmaker (0.31.1)

alphacol

Colour utilities
write.bib

Defunct Functions in pkgmaker
packageEnv

Package Development Utilities
digest_function

Compute Function Digest Hash
find_devpackage

Find Path to Development Package Root Directory
makeUnitVignette

Make Vignette for Unit Tests
file_extension

Extract File Extension
fix_registry

Fix Registry Access Functions
graphics-utils

Utility Functions for Graphics
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.
getLoadingNamespace

Namespace Development Functions
ExposeAttribute

Exposing Object Attributes
compile_src

Compile Source Files from a Development Package
citecmd

Citing Package References
iterCount

Simple Text Iteration Counter
extractLocalFun

Extracting Local Function Definition
pkgmaker-deprecated

Deprecated Functions in pkgmaker
addToLogger

Enhancing RUnit Logger
gfile

Open a File Graphic Device
CRAN

Main CRAN Mirror URL
knit_ex

Knitr Extensions
hasArg2

Checking for Missing Arguments
makeFakeVignette

Generate a Fake Vignette
packageData

Loading Package Data
regfetch

Finds an entry in a registry.
setBiocMirror

Setting Mirrors and Repositories
userData

User Data Directory userData returns the path to a local directory/file where package-related user data can be stored. Note that a base directory is always created if necessary (see details).
requireRUnit

Load RUnit Compatible Package
lverbose

Logging Feature
reorder_columns

Reordering Columns
mkoptions

Quick Option-like Feature
read.yaml_section

Reads YAML Options Embbeded into a File
writeUnitVignette

Writes Unit Tests Vignette
unlist_with_sep

Flattens All List Levels Using Separated Names
make_vignette_auxfiles

Generate RMarkdown Vignette Axiliary Files
Rversion

Complete R version
using_something

Execute code in temporarily altered environment.
render_notes

Renders rmarkdown Documents Using User Default Options
setPackageExtraHandler

Install/Run Extra Things After Standard Package Installation
add_lib

Adding Package Libraries
packageRegistry

Package Registry
exitCheck

Exit Error Checks
.packageMetaRegistry

Creates or Retrieves a Package Meta Registry
userIs

Checking R User
hasEnvar

Check Environment Variables
bibtex

Bibtex Utilities
askUser

User Queries
simpleRegistry

Simple Package Registry
source_files

Source Multiple Files
inSweave

Identifying Sweave Run
testRversion

Testing R Version
checkPlot

Plot in Unit Tests
Sys.getenv_value

System Environment Variables
R.exec

Executing R Commands
.silenceF

Silencing Functions
load_all_file

Generate a Loading Script for Development Packages
cgetAnywhere

Get Anywhere
isCRANcheck

Package Check Utils
RdSection2latex

Format Rd Sections into LatTeX
irequire

Require a Package with User Interaction
utestPath

Unit Tests Result Directory
new2

Alternative S4 Constructor
is_something

Testing Object Type
expand_list

Expanding Lists
quickinstall

Quick Installation of a Source Package
postponeAction

Postponing Actions
messagef

General Log Formating
utest

Running Unit Tests
load_project

Load Development Package
unit.test

Embedded Unit Tests
charmap

Substituting Strings Against a Mapping Table
sys_call_stack

System Call Stack Utilities
onLoad

Default Load/Unload Functions
factor2character

Converting Factors to Character Vectors
unlist_

Flatten a List Conserving Names
str_diff

Finding Differences Between Strings
list.data

List Package Data Objects
parsePackageCitation

Formatting Package Citations in Sweave/knitr Documents
utestFramework

Inferring Unit Test Framework
list.libs

Library Files Utilities
sVariable

Global Static Variable
option_symlink

option_symlink creates a symbolic link to option x.
orderVersion

Ordering Version Numbers
winbuild

Build a Windows Binary Package
latex_preamble

LaTeX Utilities for Vignettes
packageReference

Package References
is_package_path

Test for Package Root Directory
setupPackageOptions

Package Specific Options
oneoffVariable

One-off Global Variables
require.quiet

Loading Packages
setClassRegistry

Automatic S4 Class for Registry Entries
packageTestEnv

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

Formatting Utilities
checkWarning

Extra Check Functions for RUnit
rnw

Utilities for Vignettes
write.pkgbib

Generate a Bibtex File from Package Citations
addnames

Generating Names