Learn R Programming

pkgmaker (version 0.32.10)

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

1,997

Version

0.32.10

License

GPL (>= 2)

Maintainer

Last Published

May 3rd, 2023

Functions in pkgmaker (0.32.10)

Extract File Extension

factor2character

Converting Factors to Character Vectors

Open a File Graphic Device

extractLocalFun

Extracting Local Function Definition

Exit Error Checks

Expanding Lists

.packageMetaRegistry

Creates or Retrieves a Package Meta Registry

Knitr Extensions

Silencing Functions

Simple Text Iteration Counter

is_package_path

Test for Package Root Directory

Testing Object Type

Generate a Loading Script for Development Packages

Load Development Package

Check Environment Variables

Identifying Sweave Run

Logging Feature

Quick Option-like Feature

Default Load/Unload Functions

List Package Data Objects

Checking for Missing Arguments

Utility Functions for Graphics

LaTeX Utilities for Vignettes

Library Files Utilities

Ordering Version Numbers

option_symlink creates a symbolic link to option x.

Bibtex Utilities

Fix Registry Access Functions

Package Check Utils

find_devpackage

Find Path to Development Package Root Directory

Require a Package with User Interaction

makeFakeVignette

Generate a Fake Vignette

makeUnitVignette

Make Vignette for Unit Tests

Loading Packages

Loading Package Data

One-off Global Variables

Alternative S4 Constructor

Defunct Functions in pkgmaker

pkgmaker-deprecated

Deprecated Functions in pkgmaker

setPackageExtraHandler

Install/Run Extra Things After Standard Package Installation

Quick Installation of a Source Package

Postponing Actions

Source Multiple Files

Simple Package Registry

make_vignette_auxfiles

Generate RMarkdown Vignette Axiliary Files

read.yaml_section

Reads YAML Options Embbeded into a File

Setting Mirrors and Repositories

Finds an entry in a registry.

getLoadingNamespace

Namespace Development Functions

Global Static Variable

Compile a Vignette Object

Finding Differences Between Strings

Formatting Utilities

packageRegistry

Package Registry

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

Checking R User

Extra Check Functions for RUnit

parsePackageCitation

Formatting Package Citations in Sweave/knitr Documents

Embedded Unit Tests

Inferring Unit Test Framework

General Log Formating

reorder_columns

Reordering Columns

Returns the package internal environment where unit tests are stored.

packageReference

Package References

Renders rmarkdown Documents Using User Default Options

System Call Stack Utilities

Unit Tests Result Directory

Build a Windows Binary Package

Utilities for Vignettes

Load RUnit Compatible Package

Running Unit Tests

using_something

Execute code in temporarily altered environment.

Testing R Version

Generate a Bibtex File from Package Citations

writeUnitVignette

Writes Unit Tests Vignette

setupPackageOptions

Package Specific Options

setClassRegistry

Automatic S4 Class for Registry Entries

unlist_with_sep

Flattens All List Levels Using Separated Names

Flatten a List Conserving Names

Main CRAN Mirror URL

Enhancing RUnit Logger

Executing R Commands

ExposeAttribute

Exposing Object Attributes

Complete R version

Colour utilities

Sys.getenv_value

System Environment Variables

Adding Package Libraries

Generating Names

RdSection2latex

Format Rd Sections into LatTeX

digest_function

Compute Function Digest Hash

Citing Package References

Package Development Utilities

Plot in Unit Tests

Substituting Strings Against a Mapping Table

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.

Compile Source Files from a Development Package