cov_plot_data: Prepare data for Plotting Covariance Matrix

Description Usage Arguments Value Examples

View source: R/plot-covmat.R

Description

Prepare data for Plotting Covariance Matrix

Usage

1
cov_plot_data(sobj, type = "relpos", ordering = TRUE, facetting = TRUE)

Arguments

sobj

A simrel object

type

Type of covariance matrix - can take two values relpos for relevant position of principal components and relpred for relevant position of predictor variables

ordering

TRUE for ordering the covariance for block diagonal display

facetting

TRUE for facetting the predictor and response space. FALSE will give a single facet plot

Value

A data frame with covariances and related values based on type argument that is ready to plot

Examples

1
2
3
sobj <- simrel(n = 100, p = 10, q = c(4, 5), relpos = list(c(1, 2, 3), c(4, 6, 7)), m = 3,
               R2 = c(0.8, 0.7), ypos = list(c(1, 3), 2), gamma = 0.7, type = "multivariate")
head(cov_plot_data(sobj))

simulatr/simrel documentation built on Sept. 15, 2021, 12:44 a.m.