new_package {ympes} | R Documentation |
Create a package skeleton
Description
new_package()
create a package skeleton based on my preferred folder
structure.
Usage
new_package(
name = "mypackage",
dir = ".",
firstname = getOption("ympes.firstname", "Joe"),
surname = getOption("ympes.surname", "Bloggs"),
email = getOption("ympes.email", "Joe.Bloggs@missing.com"),
orcid = getOption("ympes.orcid", default = NULL),
enter = TRUE
)
np(
name = "mypackage",
dir = ".",
firstname = getOption("ympes.firstname", "Joe"),
surname = getOption("ympes.surname", "Bloggs"),
email = getOption("ympes.email", "Joe.Bloggs@missing.com"),
orcid = getOption("ympes.orcid", default = NULL),
enter = TRUE
)
Arguments
name |
Package name |
dir |
Directory to start in. |
firstname |
Maintainer's firstname. |
surname |
Maintainer's surname. |
email |
Maintainer's email address. |
orcid |
Maintainer's ORCID. |
enter |
Should you move in to the package directory after creation. Only applicable in interactive sessions. |
Value
Created directory (invisibly)
Examples
# usage without entering directory
p <- new_package("my_package_1", dir = tempdir(), enter = FALSE)
# clean up
unlink(p, recursive = TRUE)
[Package ympes version 1.3.0 Index]