use_module_readme: Add a README rmarkdown file to an existing
In dymium-org/dymiumModules: A utility package for `dymium` module management
Description
Usage
Arguments
Examples
Description
Every module must have a main READMD file which serves as the documentation
of that module. This function provides an easy way to add a README file using
the recommended template.
Usage
1
Arguments
name
(character(1))
A module name.
Examples
1
2
3
4
5
## Not run:
# this assumes that you have a module named 'demography'
use_module_readme(name = "demography")
## End(Not run)
dymium-org/dymiumModules documentation built on May 23, 2020, 10:30 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 Examples
Description
Every module must have a main READMD file which serves as the documentation of that module. This function provides an easy way to add a README file using the recommended template.
Usage
1 |
Arguments
name |
( |
Examples
1 2 3 4 5 | ## Not run:
# this assumes that you have a module named 'demography'
use_module_readme(name = "demography")
## End(Not run)
|
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.