Skip to contents

Create a package or project using a structured template

Source: R/initialize_2.0.R
initialize_project.Rd

These functions create an R project:

  • 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.

This function is a modification of usethis::create_project

Usage

initialize_project(
  path,
  rstudio = rstudioapi::isAvailable(),
  open = rlang::is_interactive(),
  fresh_install = FALSE,
  path_to_cache_root = Sys.getenv("BLASERTEMPLATES_CACHE_ROOT")
)

Arguments

path

A path. If it exists, it is used. If it does not exist, it is created, provided that the parent path exists.

rstudio

If TRUE, calls use_rstudio() to make the new package or project into an RStudio Project.

open

If TRUE, activates the new project:

  • If RStudio desktop, the package is opened in a new session.

  • If on RStudio server, the current RStudio project is activated.

  • Otherwise, the working directory and active project is changed.

Value

Path to the newly created project or package, invisibly.