bbi_{.model_type}_model objects correspond to multiple files on disk. These functions provide an easy way to retrieve the absolute path to these files.

get_model_path(.bbi_object, .check_exists = TRUE)

# S3 method for bbi_nonmem_model
get_model_path(.bbi_object, .check_exists = TRUE)

# S3 method for bbi_nonmem_summary
get_model_path(.bbi_object, .check_exists = TRUE)

# S3 method for bbi_log_df
get_model_path(.bbi_object, .check_exists = TRUE)

get_output_dir(.bbi_object, .check_exists = TRUE)

# S3 method for bbi_nonmem_model
get_output_dir(.bbi_object, .check_exists = TRUE)

# S3 method for bbi_nonmem_summary
get_output_dir(.bbi_object, .check_exists = TRUE)

# S3 method for bbi_log_df
get_output_dir(.bbi_object, .check_exists = TRUE)

get_yaml_path(.bbi_object, .check_exists = TRUE)

# S3 method for bbi_model
get_yaml_path(.bbi_object, .check_exists = TRUE)

# S3 method for bbi_log_df
get_yaml_path(.bbi_object, .check_exists = TRUE)

get_config_path(.bbi_object, .check_exists = TRUE)

# S3 method for bbi_model
get_config_path(.bbi_object, .check_exists = TRUE)

# S3 method for bbi_log_df
get_config_path(.bbi_object, .check_exists = TRUE)

Arguments

.bbi_object

The object to query. Could be a bbi_{.model_type}_model object, bbi_{.model_type}_summary object, or a tibble of class bbi_log_df.

.check_exists

If TRUE, the default, will throw an error if the file does not exist

Details

get_model_path() returns the path to the model definition file. For NONMEM models, this is the control stream. For Stan models, this is the .stan file.

get_output_dir() returns the path to the directory containing output files created when the model is run.

get_yaml_path() returns the path to the YAML file created by bbr. This file contains metadata like tags, etc. and should, generally speaking, not be interacted with directly. Use the helper functions mentioned in the modify_model_field() help page to modify this file for you.

Note that build_path_from_model() and get_data_path() provide similar functionality, but have a slightly different interface and implementation and so are documented separately.