This R package serves as a skeleton package (starter package) for HBGDki R package development. Copy and paste all files and then adjust how you see fit. This package already as
unit testing with testthat
code coverage with covr
, which is displayed at https://codecov.io
coding style with lintr
passive package testing with https://travis-ci.org
The R package roxygen2
will be used to automatically generate LaTeX documentation. A full explanation about the roxygen2
package can be found here.
Check your package by running the following commands
# generate code documentation
devtools::document()
# check code formatting
devtools::lint()
# run unit tests
devtools::test()
# check everything (R CMD check)
devtools::check()
Travis-CI is an passive testing service that downloads your R package dependencies and runs "R CMD check" on your github package. It will also run all tests and upload code coverage statistics to Codecov. This service will execute when github.com receives a code push.
Both Travis-CI and Codecov must be activated to work. Activate your R package for Travis-CI at [https://travis-ci.org/profile] and your Codecov account at [https://codecov.io/gh].
We will check for coding style using the lintr
package. This test is already provided in tests/thestthat/test-lintr.R
. Please visit jimhester/lintr for more information. "Most of the default linters are based on Hadley Wickham's R Style Guide."
options(repos = c(
CRAN = "http://cran.rstudio.com/",
tessera = "http://packages.tessera.io"))
install.packages("hbgd")
devtools::install_github("HBGDki/R_starter_pkg")
library(RStarterPkg)
Short guides to help you get started using GitHub.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.