Description Usage Arguments Details Author(s) Examples
Creates a boilerplate R package by generating the following:
DESCRIPTION file
(see pkg_description()),
NAMESPACE file
(see pkg_namespace()),
LICENSE and LICENSE.md
(see pkg_license()),
a simple R script and accompanying Rd documentation file
(see pkg_r() and pkg_rd()),
sample data, test, and vignette
(see pkg_data(), pkg_test(), and
pkg_vignette()),
optional pkgdown and travis YAML files
(see pkg_pkgdown() and pkg_travis()),
optional README.Rmd file
(see pkg_readme()), and
other files like .Rbuildignore, .gitignore, and Rproj.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | pkg_create(
pkg_dir = getwd(),
input_file = NULL,
docs = TRUE,
pkgdown = FALSE,
travis = FALSE,
appveyor = FALSE,
readme = FALSE,
add_description = NULL,
add_namespace = NULL,
add_rbuildignore = NULL,
add_gitignore = NULL,
add_travis = NULL,
add_appveyor = NULL,
git = FALSE,
github = FALSE,
commit_msg = "And so, it begins"
)
|
pkg_dir |
Character string. Directory where the package is initialized. |
input_file |
Character string.
|
docs |
Character string.
Ignore |
pkgdown |
Logical.
Create |
travis |
Logical.
Create |
appveyor |
Logical.
Create |
readme |
Logical.
Create |
add_description |
Character string.
Additional entries to the |
add_namespace |
Character string.
Entries to the |
add_rbuildignore |
Character string.
Entries to the |
add_gitignore |
Character string.
Entries to the |
add_travis |
Character string.
Entries to the |
add_appveyor |
Character string.
Entries to the |
git |
Logical. Set up a git repository. |
github |
Logical. Set up and push to a github repository. |
commit_msg |
Character string. Git commit message. |
Optionally, the function can also set up a Git repository
and push the created repo to Github.
This requires that git and hub are installed
and configured in the system.
If you are going to document, check, and build your package using devtools,
you may delete the boilerplate NAMESPACE and MAN files.
Ivan Jacob Agaloos Pesigan
1 2 3 4 5 6 7 8 9 10 | ## Not run:
pkg_create(
pkg_dir = getwd(),
pkg_name = "boilerplatePackage",
input_file = "DESCRIPTION.csv",
git = TRUE,
github = TRUE
)
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.