devCom: Developer Comments
In JDOsborne1/OSButils: Utilities Package
Description
Usage
Arguments
Value
View source: R/utilities_func.R
Description
A function which can be called in the middle of pipe pipelines
to optionally print a comment at that step. Reliant on either an object
called running_mode, or a config variable of the same name
Intended to be used in function with:
a) lots of piped steps abstracted as functions, which need some labelling.
b) lots of piped steps which are prone to failure, as a means to
identifying where in a pipeline a failure occured.
Usage
1
Arguments
input
The data flow as it would go into the next step
comment
The comment to print when prompted
Value
The same data flow, unchanged
JDOsborne1/OSButils documentation built on Jan. 8, 2021, 4:39 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value
View source: R/utilities_func.R
Description
A function which can be called in the middle of pipe pipelines to optionally print a comment at that step. Reliant on either an object called running_mode, or a config variable of the same name
Intended to be used in function with:
a) lots of piped steps abstracted as functions, which need some labelling.
b) lots of piped steps which are prone to failure, as a means to identifying where in a pipeline a failure occured.
Usage
1 |
Arguments
input |
The data flow as it would go into the next step |
comment |
The comment to print when prompted |
Value
The same data flow, unchanged
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.