get_spec_path: Get the relevant specification file path

View source: R/get-path-from-object.R

get_spec_pathR Documentation

Get the relevant specification file path

Description

Get the bootstrap specification path from a bbi_nmboot_model object or the simulation specification path from a bbi_nmsim_model or bbi_nonmem_model object.

Usage

get_spec_path(.mod, .check_exists = TRUE)

## S3 method for class 'bbi_nmboot_model'
get_spec_path(.mod, .check_exists = TRUE)

## S3 method for class 'bbi_base_model'
get_spec_path(.mod, .check_exists = TRUE)

Arguments

.mod

a ⁠bbi_{.model_type}_model⁠ object.

.check_exists

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

Value

a file path

Methods (by class)

  • get_spec_path(bbi_nmboot_model): Get the bootstrap specification file path from a bbi_nmboot_model object

  • get_spec_path(bbi_base_model): Get the simulation specification file path from a bbi_nmsim_model or bbi_nonmem_model object

Note

this is not the configuration file generated by bbi


metrumresearchgroup/rbabylon documentation built on April 12, 2025, 3:51 p.m.