generateRoxygenComment: Generate roxygen2 documentation from data check object
In bdchecks: Biodiversity Data Checks
Description
Usage
Arguments
Value
View source: R/DCclass_export.R
Description
'generateRoxygenComment()' is a function for generating roxygen2 comments for
a given data check. It's not super flexible as it just inserts metadata into
a hard coded skeleton.
Usage
1
Arguments
DC
Data check to generate documentation for.
Value
Data check description in a roxygen2 comment style
bdchecks documentation built on May 2, 2019, 4:24 a.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/DCclass_export.R
Description
'generateRoxygenComment()' is a function for generating roxygen2 comments for a given data check. It's not super flexible as it just inserts metadata into a hard coded skeleton.
Usage
1 |
Arguments
DC |
Data check to generate documentation for. |
Value
Data check description in a roxygen2 comment style
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.