Learn R Programming

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

pkgmaker (version 0.32.2)

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

License

GPL (>= 2)

Maintainer

Renaud Gaujoux

Last Published

October 20th, 2020

Functions in pkgmaker (0.32.2)

factor2character

Converting Factors to Character Vectors
mkoptions

Quick Option-like Feature
quickinstall

Quick Installation of a Source Package
RdSection2latex

Format Rd Sections into LatTeX
using_something

Execute code in temporarily altered environment.
lverbose

Logging Feature
citecmd

Citing Package References
pkgmaker-deprecated

Deprecated Functions in pkgmaker
file_extension

Extract File Extension
packageEnv

Package Development Utilities
compile_src

Compile Source Files from a Development Package
userIs

Checking R User
graphics-utils

Utility Functions for Graphics
option_symlink

option_symlink creates a symbolic link to option x.
postponeAction

Postponing Actions
hasArg2

Checking for Missing Arguments
R.exec

Executing R Commands
exitCheck

Exit Error Checks
utestPath

Unit Tests Result Directory
unit.test

Embedded Unit Tests
setBiocMirror

Setting Mirrors and Repositories
onLoad

Default Load/Unload Functions
iterCount

Simple Text Iteration Counter
cgetAnywhere

Get Anywhere
charmap

Substituting Strings Against a Mapping Table
digest_function

Compute Function Digest Hash
Sys.getenv_value

System Environment Variables
write.bib

Defunct Functions in pkgmaker
hasEnvar

Check Environment Variables
inSweave

Identifying Sweave Run
expand_list

Expanding Lists
orderVersion

Ordering Version Numbers
latex_preamble

LaTeX Utilities for Vignettes
list.libs

Library Files Utilities
find_devpackage

Find Path to Development Package Root Directory
.packageMetaRegistry

Creates or Retrieves a Package Meta Registry
sVariable

Global Static Variable
is_package_path

Test for Package Root Directory
is_something

Testing Object Type
checkWarning

Extra Check Functions for RUnit
packageReference

Package References
addToLogger

Enhancing RUnit Logger
add_lib

Adding Package Libraries
new2

Alternative S4 Constructor
list.data

List Package Data Objects
knit_ex

Knitr Extensions
.silenceF

Silencing Functions
rnw

Utilities for Vignettes
setupPackageOptions

Package Specific Options
packageRegistry

Package Registry
testRversion

Testing R Version
addnames

Generating Names
packageTestEnv

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

Namespace Development Functions
simpleRegistry

Simple Package Registry
load_all_file

Generate a Loading Script for Development Packages
utestFramework

Inferring Unit Test Framework
makeFakeVignette

Generate a Fake Vignette
winbuild

Build a Windows Binary Package
setClassRegistry

Automatic S4 Class for Registry Entries
utest

Running Unit Tests
unlist_

Flatten a List Conserving Names
bibtex

Bibtex Utilities
str_diff

Finding Differences Between Strings
fix_registry

Fix Registry Access Functions
alphacol

Colour utilities
packageData

Loading Package Data
askUser

User Queries
makeUnitVignette

Make Vignette for Unit Tests
Rversion

Complete R version
writeUnitVignette

Writes Unit Tests Vignette
setPackageExtraHandler

Install/Run Extra Things After Standard Package Installation
write.pkgbib

Generate a Bibtex File from Package Citations
load_project

Load Development Package
irequire

Require a Package with User Interaction
isCRANcheck

Package Check Utils
source_files

Source Multiple Files
oneoffVariable

One-off Global Variables
parsePackageCitation

Formatting Package Citations in Sweave/knitr Documents
CRAN

Main CRAN Mirror URL
ExposeAttribute

Exposing Object Attributes
read.yaml_section

Reads YAML Options Embbeded into a File
str_out

Formatting Utilities
messagef

General Log Formating
extractLocalFun

Extracting Local Function Definition
checkPlot

Plot in Unit Tests
require.quiet

Loading Packages
make_vignette_auxfiles

Generate RMarkdown Vignette Axiliary Files
render_notes

Renders rmarkdown Documents Using User Default Options
regfetch

Finds an entry in a registry.
sys_call_stack

System Call Stack Utilities
unlist_with_sep

Flattens All List Levels Using Separated Names
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.
reorder_columns

Reordering Columns
gfile

Open a File Graphic Device
requireRUnit

Load RUnit Compatible Package
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).