rmake (version 1.2.1)

getParam: Wrapper around the params global variable

Description

Returns an element of the global params variable that is normally used to send parameters to a script from the Makefile generated by rmake. Script parameters may be defined with the params argument of the rRule() or markdownRule() functions.

Usage

getParam(name, default = NA)

Value

The function returns an element of the given name from the params variable that is created inside the Makefile recipe. If the params global variable does not exist (the script is likely being executed directly, i.e., not from the Makefile generated by rmake), the default value is returned and a warning is generated. If the params global variable exists but it is not a list or the name element does not exist in it, an error is thrown.

Arguments

name

Name of the parameter

default

Default value to be returned if the params global variable does not exist, which typically occurs if the script is executed outside of the Makefile.

Author

Michal Burda

See Also

rRule(), markdownRule()

Examples

task <- getParam('task', 'default')