pkgtemplate provides a template for a new R package.
To install the latest release version from CRAN
install.packages("pkgtemplate")
To install the latest development version from GitHub
# install.packages("remotes")
remotes::install_github("audrey-b/pkgtemplate")
In order to create a new package the user should
1) Go to the pkgtemplate GitHub
repository and choose ‘Use
this template’.
2) Clone the new repository and replace ‘pkgtemplate’ with the name of
the new package in DESCRIPTION
, NEWS.md
, tests/testthat.R
and
this README.Rmd
file.
3) devtools::check()
the package and fix any Errors, Warnings or
Notes.
4) Knit this README.Rmd
file and pkgdown::build_site()
.
5) Add the project to
Travis and in the
Settings
add a Cron Job to run the master branch daily if there hasn’t been a
build in the last 24h.
6) Add the project to
Appveyor.
7) Rename the pkgtemplate.Rproj
file.
8) Push the changes to the new repository.
9) Go to the repository GitHub
settings and set
the GitHub Pages Source to be the master branch /docs folder.
10) Edit the GitHub repository
description and set the
website to be https://audrey-b.github.io/pkgtemplate/.
Please report any issues.
Pull requests are always welcome.
Please note that this project is released with a Contributor Code of Conduct. By contributing, 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.