Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

pkgmaker

Development Utilities for R Packages

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.

Functions (97)

CRAN

Main CRAN Mirror URL

ExposeAttribute

Exposing Object Attributes

R.exec

Executing R Commands

RdSection2latex

Format Rd Sections into LatTeX

Rversion

Complete R version

Sys.getenv_value

System Environment Variables

addToLogger

Enhancing RUnit Logger

add_lib

Adding Package Libraries

addnames

Generating Names

alphacol

Colour utilities

askUser

User Queries

bibtex

Bibtex Utilities

cgetAnywhere

Get Anywhere

charmap

Substituting Strings Against a Mapping Table

checkPlot

Plot in Unit Tests

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.

citecmd

Citing Package References

compile_src

Compile Source Files from a Development Package

devutils

Package Development Utilities

digest_function

Compute Function Digest Hash

dot-packageMetaRegistry

Creates or Retrieves a Package Meta Registry

dot-silenceF

Silencing Functions

exitCheck

Exit Error Checks

expand_list

Expanding Lists

factor2character

Converting Factors to Character Vectors

file_extension

Extract File Extension

find_devpackage

Find Path to Development Package Root Directory

fix_registry

Fix Registry Access Functions

formals

Extracting Local Function Definition

gfile

Open a File Graphic Device

graphics-utils

Utility Functions for Graphics

hasArg2

Checking for Missing Arguments

hasEnvar

Check Environment Variables

inSweave

Identifying Sweave Run

irequire

Require a Package with User Interaction

isCRANcheck

Package Check Utils

is_package_path

Test for Package Root Directory

is_something

Testing Object Type

iterCount

Simple Text Iteration Counter

knit_ex

Knitr Extensions

latex

LaTeX Utilities for Vignettes

libutils

Library Files Utilities

list.data

List Package Data Objects

load

Default Load/Unload Functions

load_all_file

Generate a Loading Script for Development Packages

load_project

Load Development Package

local-options

Quick Option-like Feature

logging

Logging Feature

makeFakeVignette

Generate a Fake Vignette

makeUnitVignette

Make Vignette for Unit Tests

make_vignette_auxfiles

Generate RMarkdown Vignette Axiliary Files

messagef

General Log Formating

mirrors

Setting Mirrors and Repositories

namespace

Namespace Development Functions

new2

Alternative S4 Constructor

oneoffVariable

One-off Global Variables

options

option_symlink creates a symbolic link to option x.

orderVersion

Ordering Version Numbers

packageData

Loading Package Data

packageExtra

Install/Run Extra Things After Standard Package Installation

packageReference

Package References

packageTestEnv

Returns the package internal environment where unit tests are stored.

packages

Loading Packages

parsePackageCitation

Formatting Package Citations in Sweave/knitr Documents

pkgmaker-defunct

Defunct Functions in pkgmaker

pkgmaker-deprecated

Deprecated Functions in pkgmaker

postponeAction

Postponing Actions

quickinstall

Quick Installation of a Source Package

read.yaml_section

Reads YAML Options Embbeded into a File

regfetch

Finds an entry in a registry.

registry

Package Registry

render_notes

Renders rmarkdown Documents Using User Default Options

reorder_columns

Reordering Columns

requireRUnit

Load RUnit Compatible Package

sVariable

Global Static Variable

setClassRegistry

Automatic S4 Class for Registry Entries

setupPackageOptions

Package Specific Options

simpleRegistry

Simple Package Registry

source_files

Source Multiple Files

str_diff

Finding Differences Between Strings

str_out

Formatting Utilities

sys_call_stack

System Call Stack Utilities

testRversion

Testing R Version

uchecks

Extra Check Functions for RUnit

unit.test

Embedded Unit Tests

unlist_

Flatten a List Conserving Names

unlist_with_sep

Flattens All List Levels Using Separated Names

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

userIs

Checking R User

using_something

Execute code in temporarily altered environment.

utest

Running Unit Tests

utestFramework

Inferring Unit Test Framework

utestPath

Unit Tests Result Directory

vignette

Utilities for Vignettes