np: Create basic package sans test setup

Description Usage Arguments Details

View source: R/np.R

Description

np() (new package) creates a minimal package with description. It borrows somewhat from Dirk Eddelbuettel's pkgKitten pkgKitten but changed to fit my workflow.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
np(
  pkgname = "mypackage",
  dir,
  license = "MIT",
  firstname = getOption("FIRSTNAME", "Joe"),
  surname = getOption("SURNAME", "Bloggs"),
  email = getOption("EMAIL", "joe@bloggs.com"),
  orcid = getOption("ORCID"),
  open = TRUE,
  rstudio = TRUE
)

Arguments

pkgname

The package name.

dir

The directory to use for the package.

license

What license to use for the package. Defaults to MIT.

firstname

Your firstname.

surname

Your surname.

email

Your email.

orcid

Your ORCID (optional).

open

Open package directory after creation.

rstudio

Use RStudio projects (.Rproj)?

Details

Authorship details will be grabbed from the options FIRSTNAME, SURNAME, EMAIL and ORCID.


tjtnew/coffee documentation built on Dec. 23, 2021, 11 a.m.