xpose (version 0.4.19)

get_file: Access model output file data

Description

Access model output file data from an xpdb object.

Usage

get_file(
  xpdb,
  file = NULL,
  ext = NULL,
  .problem = NULL,
  .subprob = NULL,
  .method = NULL,
  quiet
)

Value

A tibble for single file or a named list for multiple files.

Arguments

xpdb

An xpose_data object from which the model output file data will be extracted.

file

Full name of the file to be extracted from the xpdb e.g. 'run001.phi'. Alternative to the 'ext' argument.

ext

Extension of the file to be extracted from the xpdb e.g. 'phi'. Alternative to the 'file' argument.

.problem

The problem to be used, by default returns the last one for each file.

.subprob

The subproblem to be used, by default returns the last one for each file.

.method

The estimation method to be used (e.g. 'foce', 'imp', 'saem'), by default returns the last one for each file.

quiet

Logical, if FALSE messages are printed to the console.

See Also

list_files, xpose_data, read_nm_files

Examples

# Single file (returns a tibble)
ext_file <- get_file(xpdb_ex_pk, file = 'run001.ext')
ext_file

# Multiple files (returns a list)
files <- get_file(xpdb_ex_pk, file = c('run001.ext', 'run001.phi'))
files

# Tip to list available files in the xpdb
print(xpdb_ex_pk)