Extract results from pickle file

Usage

extract_results_from_pickle(
  n_s = 1,
  dataset_name = "sample_data",
  output_folder = "output",
  rda_filename = "data.RData",
  basename = paste0(dataset_name, "_subtype", n_s - 1),
  picklename = paste0(basename, ".pickle"),
  format_results = TRUE,
  subtype_order = seq_len(n_s),
  use_rds = TRUE,
  save_rds = format_results & identical(subtype_order, seq_len(n_s)),
  verbose = FALSE,
  ...
)

Arguments

n_s

number of latent subgroups; helps construct picklename

dataset_name

root name of dataset

output_folder

where to find the dataset

rda_filename

name of rda file containing environment used to run analyses

basename

base of pickle file name (without .pickle suffix)

picklename

the name of the pickle file to open

format_results

whether to apply format_results_list() to results before returning

subtype_order

an integer vector of length n_s, indicating how to order the subtypes

use_rds

logical whether to use previously cached results

save_rds

a logical indicating whether to save new cached results

verbose

whether to print messages

...

Arguments passed on to format_results_list

format_sst: should the subtype and stage table be formatted? (doesn't work for cross-validation fold pickle-files)

Value

a "SuStaIn_model" object (extends list())

Examples

if (FALSE) { # \dontrun{
output_path <-
  fs::path_package("extdata/sim_data", package = "fxtas")
results <- extract_results_from_pickle(
  n = 3,
  output_folder = output_path, use_rds = FALSE
)
} # }