get_path_from_object: Get path from bbi object

In metrumresearchgroup/mrgvalidatetestreference: Test reference for mrgvalidate

Description

Builds the full path to a file that is stored as part of a 'bbi_...' S3 object NOTE: All paths saved in the object or accompanying YAML will be relative **to the location of that YAML** When the object is loaded into memory, the absolute path to the YAML is stored in the object. These functions simply stitch together that path with the requested relative path. As long as the YAML has not moved since it was loaded, this will work.

Usage

get_path_from_object(.bbi_object, .key, .check_exists = TRUE)

## Default S3 method:
get_path_from_object(.bbi_object, .key, .check_exists = TRUE)

## S3 method for class 'character'
get_path_from_object(.bbi_object, .key, .check_exists = TRUE)

## S3 method for class 'bbi_run_log_df'
get_path_from_object(.bbi_object, .key, .check_exists = TRUE)

get_model_path(.bbi_object, .check_exists = TRUE)

get_output_dir(.bbi_object, .check_exists = TRUE)

get_yaml_path(.bbi_object, .check_exists = TRUE)

Arguments

.bbi_object	Tibble of class 'bbi_run_log_df'
.key	The key that contains the relative path
.check_exists	Logical scaler for whether it will check if the file exists and error if it does not. True by default.

metrumresearchgroup/mrgvalidatetestreference documentation built on Aug. 15, 2021, 8:13 a.m.