nat_setup_package: Setup a package in natverse style

Description Usage Arguments See Also Examples

View source: R/package-utils.R

Description

Setup a package in natverse style

Usage

1
2
3
4
5
6
nat_setup_package(
  path = ".",
  lifecycle = c("experimental", "maturing", "stable"),
  ci = c("github", "travis"),
  github_pkgdown = TRUE
)

Arguments

path

Path to git repository containing package (defaults to current working directory)

lifecycle

The developmental stage of the package (see https://www.tidyverse.org/lifecycle)

ci

Which ci service to use. Github is now recommended unless you have particularly complex builds.

github_pkgdown

Whether to build pkgdown docs on github (default) or to build and commit them on your own machine. The former is more convenient, the latter enables you to include data only found on your machine when building documentation.

See Also

nat_setup_badges, nat_setup_pkgdown

Examples

1
2
3
4
5
6
## Not run: 
nat.devtools::nat_setup_package(lifecycle='maturing')
nat.devtools::nat_setup_package(lifecycle='stable')
nat.devtools::nat_setup_package(lifecycle='experimental')

## End(Not run)

jefferis/nat.devtools documentation built on July 10, 2021, 12:07 p.m.