untangle_examples: Convert examples blocks in roxygen2 header to script
In sinew: Package Development Documentation and Namespace Management
View source: R/untangle_examples.R
untangle_examples R Documentation
Convert examples blocks in roxygen2 header to script
Description
Converts and aggregates roxygen2 examples into a
single output file.
Usage
untangle_examples(input, output = "./roxy_ex_to_file.R")
Arguments
input
character, file or directory
output
character, file path of output, Default: './roxy_ex_to_file.R'
Details
If output is set to NULL then output returned as invisible character object.
Value
writes R file to disk
Author(s)
Jonathan Sidi
sinew documentation built on March 31, 2022, 5:06 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.
View source: R/untangle_examples.R
| untangle_examples | R Documentation |
Convert examples blocks in roxygen2 header to script
Description
Converts and aggregates roxygen2 examples into a single output file.
Usage
untangle_examples(input, output = "./roxy_ex_to_file.R")
Arguments
input |
character, file or directory |
output |
character, file path of output, Default: './roxy_ex_to_file.R' |
Details
If output is set to NULL then output returned as invisible character object.
Value
writes R file to disk
Author(s)
Jonathan Sidi
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.