Skip to contents

Create an R package according to INBO requirements

Source: R/create_package.R
create_package.Rd

Creates a package template in a new folder. Use this function when you want to start a new package. Please DO READ vignette("getting_started") before running this function.

Usage

create_package(package, path = ".")

Arguments

package

Name of the new package.

path

Where to create the package directory.

Details

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.

See also

Other setup: create_project(), prepare_ghpages(), set_license(), setup_package(), setup_project(), setup_source()