addCor: add correlations of off-diagonal OMEGA and SIGMA elements to...

View source: R/addCor.R

addCorR Documentation

add correlations of off-diagonal OMEGA and SIGMA elements to a parameter table

Description

add correlations of off-diagonal OMEGA and SIGMA elements to a parameter table

Usage

addCor(pars, by = NULL, as.fun, col.value = "value")

Arguments

pars

A parameter table, like returned by 'NMreadExt()'.

by

The name of a column, as a string. Calculate the correlations within a grouping variable? This will often be a column containing the model name.

as.fun

See '?NMdataConf'

col.value

The name of the column from which to take the 'OMEGA' values. Default is "value" in alignment with the output from 'NMreadExt()'.

Value

The parameter table with a 'corr' column added.


philipdelff/NMdata documentation built on March 5, 2025, 12:20 a.m.