Learn R Programming

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

pkgmaker (version 0.31)

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

214

Version

0.31

License

GPL (>= 2)

Maintainer

Renaud Gaujoux

Last Published

January 22nd, 2020

Functions in pkgmaker (0.31)

Package Development Utilities

Citing Package References

Substituting Strings Against a Mapping Table

Identifying Sweave Run

Extract File Extension

Check Environment Variables

factor2character

Converting Factors to Character Vectors

Exit Error Checks

Compile Source Files from a Development Package

Colour utilities

Plot in Unit Tests

Utility Functions for Graphics

reorder_columns

Reordering Columns

make_vignette_auxfiles

Generate RMarkdown Vignette Axiliary Files

Load Development Package

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

Expanding Lists

Generate a Loading Script for Development Packages

Quick Option-like Feature

Checking for Missing Arguments

Simple Text Iteration Counter

General Log Formating

digest_function

Compute Function Digest Hash

makeUnitVignette

Make Vignette for Unit Tests

makeFakeVignette

Generate a Fake Vignette

Fix Registry Access Functions

Embedded Unit Tests

Require a Package with User Interaction

Alternative S4 Constructor

Package Check Utils

find_devpackage

Find Path to Development Package Root Directory

Logging Feature

Silencing Functions

packageRegistry

Package Registry

Renders rmarkdown Documents Using User Default Options

Flatten a List Conserving Names

Utilities for Vignettes

packageReference

Package References

Returns the package internal environment where unit tests are stored.

One-off Global Variables

Unit Tests Result Directory

Setting Mirrors and Repositories

Checking R User

Bibtex Utilities

option_symlink creates a symbolic link to option x.

Postponing Actions

Quick Installation of a Source Package

getLoadingNamespace

Namespace Development Functions

.packageMetaRegistry

Creates or Retrieves a Package Meta Registry

List Package Data Objects

Simple Package Registry

setupPackageOptions

Package Specific Options

using_something

Execute code in temporarily altered environment.

Loading Packages

extractLocalFun

Extracting Local Function Definition

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.

Open a File Graphic Device

Loading Package Data

Knitr Extensions

Testing R Version

Extra Check Functions for RUnit

LaTeX Utilities for Vignettes

Library Files Utilities

parsePackageCitation

Formatting Package Citations in Sweave/knitr Documents

Load RUnit Compatible Package

setPackageExtraHandler

Install/Run Extra Things After Standard Package Installation

Defunct Functions in pkgmaker

setClassRegistry

Automatic S4 Class for Registry Entries

Global Static Variable

Build a Windows Binary Package

unlist_with_sep

Flattens All List Levels Using Separated Names

pkgmaker-deprecated

Deprecated Functions in pkgmaker

Generate a Bibtex File from Package Citations

writeUnitVignette

Writes Unit Tests Vignette

Finding Differences Between Strings

Default Load/Unload Functions

Ordering Version Numbers

is_package_path

Test for Package Root Directory

Testing Object Type

Source Multiple Files

read.yaml_section

Reads YAML Options Embbeded into a File

Finds an entry in a registry.

Inferring Unit Test Framework

Formatting Utilities

Running Unit Tests

System Call Stack Utilities

Enhancing RUnit Logger

Sys.getenv_value

System Environment Variables

Complete R version

Main CRAN Mirror URL

ExposeAttribute

Exposing Object Attributes

Adding Package Libraries

Generating Names

Executing R Commands

RdSection2latex

Format Rd Sections into LatTeX