Learn R Programming

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

pkgmaker (version 0.27)

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

113

Version

0.27

License

GPL (>= 2)

Maintainer

Renaud Gaujoux

Last Published

May 26th, 2018

Functions in pkgmaker (0.27)

Complete R version

Quick Option-like Feature

Returns the package internal environment where unit tests are stored.

Loading Packages

Quick Installation of a Source Package

Enhancing RUnit Logger

read.yaml_section

Reads YAML Options Embbeded into a File

Adding Package Libraries

Finding Differences Between Strings

Executing R Commands

RdSection2latex

Format Rd Sections into LatTeX

Formatting Utilities

Compile Source Files from a Development Package

Citing Package References

Substituting Strings Against a Mapping Table

Silencing Functions

Unit Tests Result Directory

Fix Registry Access Functions

Utilities for Vignettes

Exit Error Checks

Package Check Utils

Checking for Missing Arguments

extractLocalFun

Extracting Local Function Definition

Check Environment Variables

makeUnitVignette

Make Vignette for Unit Tests

make_vignette_auxfiles

Generate RMarkdown Vignette Axiliary Files

One-off Global Variables

is_package_path

Test for Package Root Directory

General Log Formating

Setting Mirrors and Repositories

Extract File Extension

option_symlink creates a symbolic link to option x.

Identifying Sweave Run

find_devpackage

Find Path to Development Package Root Directory

Testing R Version

packageRegistry

Package Registry

Finds an entry in a registry.

Extra Check Functions for RUnit

Ordering Version Numbers

Generating Names

Colour utilities

Expanding Lists

factor2character

Converting Factors to Character Vectors

Plot in Unit Tests

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.

Loading Package Data

Require a Package with User Interaction

Embedded Unit Tests

pkgmaker-deprecated

Deprecated Functions in pkgmaker

Checking R User

using_something

Execute code in temporarily altered environment.

Postponing Actions

Logging Feature

Knitr Extensions

LaTeX Utilities for Vignettes

Flatten a List Conserving Names

writeUnitVignette

Writes Unit Tests Vignette

Library Files Utilities

Default Load/Unload Functions

parsePackageCitation

Formatting Package Citations in Sweave/knitr Documents

Defunct Functions in pkgmaker

makeFakeVignette

Generate a Fake Vignette

ExposeAttribute

Exposing Object Attributes

Main CRAN Mirror URL

setupPackageOptions

Package Specific Options

setClassRegistry

Automatic S4 Class for Registry Entries

Running Unit Tests

Inferring Unit Test Framework

getLoadingNamespace

Namespace Development Functions

Open a File Graphic Device

Utility Functions for Graphics

Alternative S4 Constructor

Testing Object Type

Bibtex Utilities

Simple Text Iteration Counter

Renders rmarkdown Documents Using User Default Options

setPackageExtraHandler

Install/Run Extra Things After Standard Package Installation

Load RUnit Compatible Package

reorder_columns

Reordering Columns

packageReference

Package References

Simple Package Registry

Source Multiple Files

unlist_with_sep

Flattens All List Levels Using Separated Names

Global Static Variable

Build a Windows Binary Package

Generate a Bibtex File from Package Citations

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).

Sys.getenv_value

System Environment Variables

Package Development Utilities

.packageMetaRegistry

Creates or Retrieves a Package Meta Registry

Load Development Package