param_table: Create parameter tables

View source: R/param_table.R

param_tableR Documentation

Create parameter tables

Description

param_table() is useful for formatting tables of NONMEM parameter estimates for single or multiple runs. If successive runs have more/fewer parameters (THETAs, OMEGAs, or SIGMAs), the parameters in common between runs will be aligned for ease of comparison.

Usage

param_table(
  ...,
  nice = TRUE,
  transform = TRUE,
  write = FALSE,
  filename = NULL,
  value_digits = 2,
  rse_digits = 1,
  max_omega = 30,
  max_sigma = 5
)

Arguments

...

Run number(s) or model names(s).

nice

Whether to use Value [%RSE] formatting.

transform

Whether to transform diagonal elements of OMEGA and SIGMA to standard deviations, and off-diagonal elements to correlations.

write

Whether to write to a csv file.

filename

Name of the csv file, if write == TRUE.

value_digits

How many decimal places to display for parameter estimates when using "nice" formatting.

rse_digits

How many decimal places to display for %RSE estimates when using "nice" formatting.

max_omega

Maximum number of OMEGAs in model.

max_sigma

Maximum number of SIGMAs in model.

Value

A tibble::tibble() containing NONMEM parameter estimates.

Author(s)

Sandy Floren

Examples

## Not run: 
# Make a parameter table for a single model called "run3.mod", which must be
# present in the current directory
param_table(3)

# For 3 successive runs: "run3.mod", "run4.mod", and "run5.mod" and write to
# a csv
param_table(3, 4, 5, write = TRUE)

## End(Not run)


saviclab/savictools documentation built on Dec. 7, 2023, 11:56 p.m.