get_description: Get struct object help description
In computational-metabolomics/struct: Statistics in R Using Class-based Templates
get_description R Documentation
Get struct object help description
Description
This
function is to help developers including struct objects in their own R
packages, and isnt intended for general use.
Use with roxygen 2 '@eval' tags this function generates a detailed
description of a struct object generated by extracting names,
descriptions etc from slots in a suitable format.
Usage
get_description(id)
Arguments
id
(character) the name of a struct object to generate documentation for
Value
a character string of roxygen formatted documentation for the object
Examples
get_description('example_model')
computational-metabolomics/struct documentation built on March 27, 2024, 4:26 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.
| get_description | R Documentation |
Get struct object help description
Description
This function is to help developers including struct objects in their own R packages, and isnt intended for general use. Use with roxygen 2 '@eval' tags this function generates a detailed description of a struct object generated by extracting names, descriptions etc from slots in a suitable format.
Usage
get_description(id)
Arguments
id |
(character) the name of a struct object to generate documentation for |
Value
a character string of roxygen formatted documentation for the object
Examples
get_description('example_model')
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.