model_summary: S3 generic for getting model summary

Description Usage Arguments Value

View source: R/summary.R

Description

S3 generic for getting model summary

Get model summary from 'bbi_nonmem_model' object and optionally check if model is done before erroring

S3 dispatch for getting model summary from output directory path

S3 dispatch for getting model summary from numeric input This will only work if you are calling from the same directory as the models, or if you have set the model directory with 'set_model_directory()'

Run 'bbi nonmem summary' and parse the output to a list

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
model_summary(
  .mod,
  .model_type = NULL,
  .bbi_args = NULL,
  ...,
  .dry_run = FALSE,
  .directory = NULL
)

## S3 method for class 'bbi_nonmem_model'
model_summary(
  .mod,
  .model_type = NULL,
  .bbi_args = NULL,
  ...,
  .dry_run = FALSE,
  .directory = NULL
)

## S3 method for class 'character'
model_summary(
  .mod,
  .model_type = c("nonmem", "stan"),
  .bbi_args = NULL,
  ...,
  .dry_run = FALSE,
  .directory = get_model_directory()
)

## S3 method for class 'numeric'
model_summary(
  .mod,
  .model_type = c("nonmem", "stan"),
  .bbi_args = NULL,
  ...,
  .dry_run = FALSE,
  .directory = get_model_directory()
)

nonmem_summary(.mod, .bbi_args = NULL, ..., .dry_run = FALSE)

Arguments

.mod

'bbi_nonmem_model' object for summary

.model_type

Character scaler specifying the type of model, either 'nonmem' or 'stan'

.bbi_args

A named list specifying arguments to pass to babylon formatted like 'list("nm_version" = "nm74gf_nmfe", "json" = T, "threads" = 4)'. Run 'print_nonmem_args()' to see valid arguments.

...

args passed through to 'bbi_exec()'

.dry_run

show what the command would be without actually running it

.directory

Model directory containing the files referenced by ‘.mod'. Defaults to 'options(’rbabylon.model_directory')', which can be set globally with 'set_model_directory()'.

Value

List of S3 Class "bbi_nonmem_summary" with all summary information


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