include_roxygen_example: include_roxygen_example
In jspaezp/sctree: Tree based analysis of single rna-seq clusters
Description
Usage
Arguments
Details
Value
Description
Include the output of code in your documentation automatically
Usage
1
include_roxygen_example(example_string)
Arguments
example_string
the string to be interpreted as R code
Details
This function takes a string that can be interpreted as r code and returns it
formatted as a roxygen exmaple, including tags and output commented out.
It is meant to be used with the evalRd tag as
‘#’ @evalRd include_roxygen_example("print('a')")'
Value
a string that can be interpreted literally as a roxygen comment
jspaezp/sctree documentation built on April 30, 2020, 10:36 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 Details Value
Description
Include the output of code in your documentation automatically
Usage
1 | include_roxygen_example(example_string)
|
Arguments
example_string |
the string to be interpreted as R code |
Details
This function takes a string that can be interpreted as r code and returns it formatted as a roxygen exmaple, including tags and output commented out.
It is meant to be used with the evalRd tag as ‘#’ @evalRd include_roxygen_example("print('a')")'
Value
a string that can be interpreted literally as a roxygen comment
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.