describe_correlation: Define a correlation matrix

Description Usage Arguments Value

View source: R/param_classes.R

Description

Define a correlation matrix

Usage

1
describe_correlation(type, correlation)

Arguments

type

chr, Type of a correlation matrix: "constant" for a matrix where every off-diagonal term is the same (specified by the correlation parameter), "exponential" for a matrix where correlation between variables decays exponentially.

correlation

Value of the correlation coefficient. In case of an exponentially decaying correlation, this is the exponent base.

Value

object of class 'cor_desc' - a list of type and correlation value.


StatsIMUWr/slobeC documentation built on Oct. 31, 2019, 12:03 a.m.