summarize_parameters_correlations: Parameters correlations

In pnolain/pmxploit: Pharmacometric tools for post-processing of mixed-effects models for continuous data

Parameters correlations

Description

Returns the selected parameters correlations in the form of either a matrix, a data frame or a plot.

Usage

summarize_parameters_correlations(
  run,
  parameters = NULL,
  baseline_only = TRUE,
  correlation_method = NULL,
  auto_order = TRUE
)

Arguments

run	pmxploit NONMEM run object.
parameters	character vector of parameters names. Default is NULL, returning all individual parameters (random and post-hoc).
baseline_only	logical. Consider only the baseline (= first) values of the subjects. Default is TRUE.
correlation_method	a character string indicating which correlation coefficient (or covariance) is to be computed. One of "pearson" (default), "kendall", or "spearman": can be abbreviated. If type = "scatterplot", "pearson" method will be used.
auto_order	logical. If type = "heatmap", auto-orders the matrix with respect to the distances between values. Default is TRUE.

Value

A matrix.

Examples

EXAMPLERUN %>% summarize_parameters_correlations()
EXAMPLERUN %>% summarize_parameters_correlations(auto_order = FALSE)

pnolain/pmxploit documentation built on Jan. 31, 2024, 1:16 p.m.