Package index • rmake

Build Process Creation and Management

Core functions to define and execute the build process.

rmakeSkeleton(): Prepare an existing project for building with rmake.
makefile(): Generate Makefile from a given list of rules (job).
make(): Run make in the system
visualizeRules(): Visualize dependencies defined by a rule or a list of rules
defaultVars: Variables used within the Makefile generating process

Functions for defining different types of build rules.

rule(): General creator of an instance of the S3 rmake.rule class
rRule(): Rule for running R scripts
markdownRule(): Rule for building text documents from Markdown files
knitrRule(): Rule for building text documents using the knitr package
copyRule(): Rule for copying a file to a new location
offlineRule(): Rule for requesting manual user action
depRule(): A rule that defines a dependency between targets without actually providing any execution script.
subdirRule(): Rule for running the make process in a subdirectory

Functions for creating parameterized and template-based rules.

expandTemplate(): Expand template rules into a list of rules by replacing rmake variables with their values
getParam(): Wrapper around the params global variable

Special operators for creating rule chains.

Functions to extract information from rules.

prerequisites() targets() tasks() terminals(): Return a given set of properties of all rules in a list

Helper functions for working with rules and building.

hasGnuMake(): Check if GNU Make is available via the 'make' command
inShell(): Convert R code to a character vector of shell commands evaluating the given R code.
is.rule(): Check if the argument is a valid rule object.
sanitizePath(): Sanitize a file path for the current operating system
sanitizeSpaces(): Escape spaces in a string as needed in file names used in Makefile files
replaceSuffix(): Replace the suffix of a given file name with a new extension (suffix)
replaceVariables(): Replace rmake variables in a character vector