par_cov_summary: Summarize individual parameter values and covariates

In UUPharmacometrics/xpose4: Diagnostics for Nonlinear Mixed-Effect Models

Summarize individual parameter values and covariates

Description

These functions produce tables, printed to the screen, summarizing the individual parameter values or covariates from a dataset in Xpose 4.

Usage

cov.summary(
  object,
  onlyfirst = TRUE,
  subset = xsubset(object),
  inclZeroWRES = FALSE,
  out.file = ".screen",
  main = "Default",
  fill = "gray",
  values.to.use = xvardef("covariates", object),
  value.name = "Covariate",
  ...
)

parm.summary(
  object,
  onlyfirst = TRUE,
  subset = xsubset(object),
  inclZeroWRES = FALSE,
  out.file = ".screen",
  main = "Default",
  fill = "gray",
  values.to.use = xvardef("parms", object),
  value.name = "Parameter",
  max.plots.per.page = 1,
  ...
)

Arguments

object	An xpose.data object.
onlyfirst	Logical value indicating if only the first row per individual is included in the plot.
subset	A string giving the subset expression to be applied to the data before plotting. See xsubset.
inclZeroWRES	Logical value indicating whether rows with WRES=0 are included in the plot. The default is FALSE.
out.file	Where the results should be output to. Can be ".screen", ".ask", ".graph" or a filename in quotes.
main	The title of the plot. If "Default" then a default title is plotted. Otherwise the value should be a string like "my title" or NULL for no plot title.
fill	The color to fill the boxes in the table if the table is printed to ".graph"
values.to.use	Which values should be summarized
value.name	The name of the values
...	Other arguments passed to Data and SData.
max.plots.per.page	Maximum plots per page.

Value

Returned is the matrix of values from the table. parm.summary and cov.summary produce summaries of parameters and covariates, respectively. parm.summary produces less attractive output but supports mirror functionality.

parm.summary and cov.summary utilize print.char.matrix to print the information to the screen.

Functions

• cov.summary(): Covariate summary

• parm.summary(): Parameter summary

Author(s)

Andrew Hooker & Justin Wilkins

See Also

Data, SData, xpose.data-class, print.char.matrix

Other data functions: add_transformed_columns, change_graphical_parameters, change_misc_parameters, compute.cwres(), data.checkout(), data_extract_or_assign, db.names(), export.graph.par(), export.variable.definitions(), import.graph.par(), import.variable.definitions(), make.sb.data(), nsim(), read.TTE.sim.data(), read.nm.tables(), read_NM_output, read_nm_table(), simprazExample(), tabulate.parameters(), xlabel(), xpose.data, xpose.print(), xpose4-package, xsubset()

Examples

parm.summary(simpraz.xpdb)

UUPharmacometrics/xpose4 documentation built on Feb. 22, 2024, 5:02 p.m.