The goal of templateRpackage is to …
Installation
# install.packages("devtools")
devtools::install_github("EcologyR/templateRpackage")The code to create this package is available here.
Example
This is a basic example which shows you how to solve a common problem:
# library(templateRpackage)
## basic example codeWhat is special about using README.Rmd instead of just README.md? You can include R chunks like so:
summary(cars)
#> speed dist
#> Min. : 4.0 Min. : 2.00
#> 1st Qu.:12.0 1st Qu.: 26.00
#> Median :15.0 Median : 36.00
#> Mean :15.4 Mean : 42.98
#> 3rd Qu.:19.0 3rd Qu.: 56.00
#> Max. :25.0 Max. :120.00You’ll still need to render README.Rmd regularly, to keep README.md up-to-date. devtools::build_readme() is handy for this. You could also use GitHub Actions to re-render README.Rmd every time you push. An example workflow can be found here: https://github.com/r-lib/actions/tree/v1/examples.
You can also embed plots, for example:
plot(pressure)In that case, don’t forget to commit and push the resulting figure files, so they display on GitHub and CRAN.
Citation
If using this package, please cite it:
citation("templateRpackage")
To cite templateRpackage in publications use:
Rodriguez-Sanchez F. 2023. templateRpackage.
https://ecologyr.github.io/templateRpackage/
A BibTeX entry for LaTeX users is
@Manual{,
title = {templateRpackage},
author = {Francisco Rodriguez-Sanchez},
year = {2023},
url = {https://ecologyr.github.io/templateRpackage/},
}