create_folder {chkptstanr}

Create Folder for Checkpointing

Description

Create the folder for checkingpointing, which will "house" additional folders for the .stan model, checkpointing information, and draws from the posterior distribution.

Usage

create_folder(folder_name = "cp_folder", path = NULL)

Arguments

folder_name

Character string. Desired name for the "parent" folder (defaults to checkpoint).

path

Character string, when specified. Defaults to NULL, which then makes the folder in the working directory.

Value

No return value, and instead creates a directory with folders that will contain the checkpointing samples and other information.

Note

This creates a directory with four folders:

• cmd_fit: The cmdstanr fittted models (one for each checkpoint).

• cp_info: Mass matrix, step size, and initial values for next checkpoint (last iteration from previous checkpoint).

• cp_samples: Samples from the posterior distribution (post warmup)

• stan_model: Complied Stan model

Examples

path <- create_folder(folder_name = "cp_folder")

# remove folder
unlink("cp_folder", recursive = TRUE)