make_correlation_matrix: Create a correlation matrix object

Description Usage Arguments Value

View source: R/param_classes.R

Description

Create a correlation matrix object

Usage

1
make_correlation_matrix(type, correlation, dimension)

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.

dimension

Number of columns of the matrix

Value

Object of class "cor_matrix" that consist of the matrix type, correlation coefficient and dimension of the matrix.


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