process.parTable: Format parameter estimate table

View source: R/process.parTable.r

process.parTableR Documentation

Format parameter estimate table

Description

Process parameter table for inclusion into LaTeX, or MS Excel or Word

Usage

process.parTable(
  nm,
  index = 1,
  ci = 0.95,
  digits = 3,
  formatted = TRUE,
  latex = FALSE,
  align.dot = FALSE,
  transformations,
  Descriptor,
  plain = FALSE,
  missing.format = ".....",
  remove.fixed.sigma = FALSE
)

Arguments

nm

output from nm.params.table

index

which estimation (only relevant in case of multiple $EST)

ci

confidence interval for 95% CI

digits

number of significant digits in output

formatted

whether to enforce length of significant digits, see formatted.signif

latex

passed to formatted.signif

align.dot

passed to formatted.signif

transformations

a list with elements log or logit, that, in turn, are numeric vectors representating the THETA numbers that are logged or logit-transformed, respectively.

Descriptor

vector of descriptor (alias) names for numbered parameter estimates. For example c("CL","V1","SD(CL)","cor(CL,V1)","SD(V1)","prop. residual var.")

plain

logical (defaults to F) indicating if LaTeX formatting of the table should be skipped, allowing the result to be easily available for Microsoft products.

missing.format

what to replace non-estimated / fixed parameter estimates, or

remove.fixed.sigma

logical option to remove sigma estimates from the table

Value

Either a LaTeX preformatted parameter estimate table (default) or a fully processed parameter estimate table without LaTeX preformatting (for inclusion into Microsoft products).

See Also

nm.params.table, process.runrec

Examples

process.parTable(
   nm = nm.params.table(run = "example1", path = getOption("qpExampleDir"), runIndex = 1)
 , transformations = list(log = c(1:12))
 , missing.format = "...."
)
process.parTable(
   nm = nm.params.table(run = "example1", path = getOption("qpExampleDir"))
 , transformations = list(logit = c(7,9))
 , plain = TRUE
 , missing.format = "...."
)
process.parTable(
   nm = nm.params.table(run = "example1", path = getOption("qpExampleDir"))
 , transformations = list(logit = c(7,9))
 , plain = TRUE
 , formatted = FALSE
 , missing.format = "...."
)

qPharmetra/qpToolkit documentation built on May 24, 2023, 8:52 a.m.