cov_cor: NONMEM Covariance and Correlation Matrices

View source: R/cov-cor.R

cov_corR Documentation

NONMEM Covariance and Correlation Matrices

Description

Pulls in the covariance and correlation matrices (for the final estimation method) for NONMEM models. If no .cov or .cor files are found for the relevant model, will error informing the user.

Usage

cov_cor(.mod, .threshold = NULL, ..., .dry_run = FALSE)

## S3 method for class 'bbi_nonmem_model'
cov_cor(.mod, .threshold = NULL, ..., .dry_run = FALSE)

## S3 method for class 'bbi_nonmem_summary'
cov_cor(.mod, .threshold = NULL, ..., .dry_run = FALSE)

Arguments

.mod

Model to check.

.threshold

Numeric scalar between 0 and 1. Will print a warning if the absolute values of any of the off-diagonals in the correlation matrix are above this threshold. If NULL, the default, skips this check.

...

args passed through to bbi_exec()

.dry_run

show what the command would be without actually running it

Value

A named list of matrices.

Methods (by class)

  • cov_cor(bbi_nonmem_model): Get cov and cor from bbi_nonmem_model object

  • cov_cor(bbi_nonmem_summary): Get cov and cor from bbi_nonmem_summary object (output of model_summary())

See Also

model_summary(), check_cor_threshold()


metrumresearchgroup/rbabylon documentation built on April 21, 2024, 3:26 a.m.