R/setup_package.R
setup_package.Rd
Use this function when you have an existing package and you want to use the
checklist functionality.
Please keep in mind that the checklist is an opinionated list of checks.
It might require some breaking changes in your package.
Please DO READ vignette("getting_started")
before running this function.
setup_package(path = ".", license = c("GPL-3", "MIT"))
The path to the package.
Defaults to "."
.
What type of license should be used? Choice between GPL-3 and MIT. Default GPL-3.
What you get with a checklist setup:
minimal folder structure and files required for an R package using INBO guidelines with GPL-3 or MIT license.
an RStudio project file
a local git repository
an initial NEWS.md
file
a template for an README.Rmd
set-up for automated checks and releases of the package using GitHub Actions.
a code of conduct and contributing guidelines.
the set-up for a pkgdown
website using the INBO corporate identity.
Other setup:
create_package()
,
create_project()
,
prepare_ghpages()
,
setup_project()
,
setup_source()