init_sim_project: Create a simulation project

In Yu-Group/simChef: Intensive Computational Experiments Made Easy

Create a simulation project

Description

init_sim_project() initializes a directory for your simulation study. It wraps around usethis::create_project(), as well as usethis::use_git() and renv::init().

Usage

init_sim_project(
  path,
  init_git = TRUE,
  init_renv = TRUE,
  init_tests = TRUE,
  init_dirs = NULL
)

Arguments

path	Character string, specifying the path for your simulation directory.
init_git	Logical, indicating whether to intialize your simulation directory as a git repository. Defaults to TRUE.
init_renv	Logical, stating whether to initialize renv with init() from the renv package. Defaults to TRUE.
init_tests	Logical, indicating whether to generate sub-directories for organizing unit tests. Defaults to TRUE.
init_dirs	Character vector, specifying additional directories to create in the simulation project. Defaults to NULL.

Examples

## Not run: 
# create template directory for simulation project
init_sim_project("path/to/sim")
## End(Not run)

Yu-Group/simChef documentation built on Jan. 11, 2025, 1:25 a.m.