nm_summary: Generate a summary of NONMEM results

In NMproject: Script Based 'NONMEM' Model Development

Generate a summary of NONMEM results

Description

Get wide (or a long) tibble showing summary results.

Usage

summary_wide(
  ...,
  include_fields = character(),
  parameters = c("none", "new", "all"),
  m = TRUE,
  trans = TRUE
)

summary_long(..., parameters = c("none", "new", "all"))

Arguments

...	Arguments passed to summary(), usually a vector of nm object + options.
include_fields	Character vector of nm object fields to include as columns in the output. Default is empty.
parameters	Character. Either "none" (default), "new", or "all" indicating whether parameter values should be included in the summary tibble. Specifying "new" means that only parameters that aren't in the parent run are included in outputs. This is useful if wanting to know the value of an added parameter but not all the parameters (e.g. in a covariate analysis).
m	Logical (default = TRUE). Should model object be included as the m column.
trans	Logical (default = TRUE). Should parameters be transformed in accordance with $THETA/$OMEGA/$SIGMA comments. This is only valid if parameters is "new" or "all.

Value

A wide format tibble with run results.

A long format tibble with run results coerced to character form.

Examples

## requires NONMEM to be installed

## Not run: 

summary_wide(c(m1, m2))
summary_long(c(m1, m2))


## End(Not run)
  

NMproject documentation built on Sept. 30, 2022, 1:06 a.m.