knitr::opts_chunk$set( collapse = TRUE, comment = "#>", fig.path = "man/figures/README-" )
EDIT: ADD BADGES CREATED WITH:
use_lifecycle_badge("experimental") use_cran_badge()
EDIT: CONSIDER ADDING BADGES CREATED WITH:
# In .travis.yml consider adding `warnings_are_errors: false` # IMPORTANT (to avoid errors due to low limit rate): # Get GITHUB_PAT with usethis::edit_r_environ() and set it as environmental # variablel on travis (see https://github.com/forestgeo/learn/issues/148) use_travis() use_coverage("coveralls")
The goal of EDIT-PACKAGE-NAME is to ...
Install the latest stable version of EDIT-PACKAGE-NAME with:
# install.packages("devtools") devtools::install_github("forestgeo/EDIT-PACKAGE-NAME@*release")
Install the development version of EDIT-PACKAGE-NAME with:
# install.packages("devtools") devtools::install_github("forestgeo/EDIT-PACKAGE-NAME")
Or install all fgeo packages in one step.
## TODO: Add example
EDIT: Run this chunk then delete it: TODO: Move files to .github/ but refer to (FILE.md), not (.github/FILE.md)
usethis::use_template("SUPPORT.md", package = "fgeo.template") usethis::use_template("CONTRIBUTING.md", package = "fgeo.template") usethis::use_template("CODE_OF_CONDUCT.md", package = "fgeo.template") usethis::use_template("ISSUE_TEMPLATE.md", package = "fgeo.template")
What is special about using README.Rmd
instead of just README.md
? You can include R chunks like so:
summary(cars)
You'll still need to render README.Rmd
regularly, to keep README.md
up-to-date.
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!
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.