create_package {usethis} | R Documentation |
Create a package or project
Description
These functions create an R project:
-
create_package()
creates an R package -
create_project()
creates a non-package project, i.e. a data analysis project
Both functions can be called on an existing project; you will be asked before any existing files are changed.
Usage
create_package(
path,
fields = list(),
rstudio = rstudioapi::isAvailable(),
roxygen = TRUE,
check_name = TRUE,
open = rlang::is_interactive()
)
create_project(
path,
rstudio = rstudioapi::isAvailable(),
open = rlang::is_interactive()
)
Arguments
path |
A path. If it exists, it is used. If it does not exist, it is created, provided that the parent path exists. |
fields |
A named list of fields to add to |
rstudio |
If |
roxygen |
Do you plan to use roxygen2 to document your package? |
check_name |
Whether to check if the name is valid for CRAN and throw an error if not. |
open |
If
|
Value
Path to the newly created project or package, invisibly.
See Also
create_tidy_package()
is a convenience function that extends
create_package()
by immediately applying as many of the tidyverse
development conventions as possible.