pacta.multi.loanbook (version 0.1.1)

initialise_default_project: Initialise a project directory and its config file

Description

initialise_default_project() sets up a default project directory, including a project directory, a default config.yml configuration file, an input sub-directory, and a loanbooks sub-directory.

Usage

initialise_default_project(path = "project")
initialize_default_project(path = "project")

Value

initialise_default_project() returns NULL invisibly. The function is called for its side effects of creating a default project directory at the specified path.

Arguments

path

an absolute or relative path pointing to the location you would like the project directory to be created

Examples

if (FALSE) {
project_dir <- "path/to/project"
initialise_default_project(project_dir)
}