Skip to contents

This function initializes or updates all boilerplate databases with default values. It's a convenience wrapper around boilerplate_init_category() for all categories.

Usage

boilerplate_init(
  categories = c("measures", "methods", "results", "discussion", "appendix", "template"),
  merge_strategy = c("keep_existing", "merge_recursive", "overwrite_all"),
  data_path = NULL,
  quiet = FALSE,
  dry_run = FALSE,
  create_dirs = FALSE,
  confirm = TRUE,
  create_empty = TRUE
)

Arguments

categories

Character vector. Categories to initialize. Default is all categories: "measures", "methods", "results", "discussion", "appendix", "template".

merge_strategy

Character. How to merge with existing databases: "keep_existing", "merge_recursive", or "overwrite_all".

data_path

Character. Base path for data directory. If NULL (default), uses here::here("boilerplate", "data").

quiet

Logical. If TRUE, suppresses all CLI alerts. Default is FALSE.

dry_run

Logical. If TRUE, simulates the operation without writing files. Default is FALSE.

create_dirs

Logical. If TRUE, creates directories that don't exist. Default is FALSE.

confirm

Logical. If TRUE, asks for confirmation before making changes. Default is TRUE.

create_empty

Logical. If TRUE, creates empty database structures with just the template headings. Default is TRUE. Set to FALSE to use default content.

Value

Invisibly returns a logical vector indicating which categories were successfully initialized.

Examples

if (FALSE) { # \dontrun{
# run in dry-run mode first to see what would happen
boilerplate_init(dry_run = TRUE)

# initialize all databases with empty structures
boilerplate_init(create_dirs = TRUE, create_empty = TRUE)

# initialize all databases with default content
boilerplate_init(create_dirs = TRUE, create_empty = FALSE)

# initialize specific categories only
boilerplate_init(
  categories = c("methods", "measures"),
  create_dirs = TRUE,
  confirm = FALSE
)
} # }