docs/functions/plot.factor.correlations.md

plot.factor.correlations

Plot factor correlations for the specified w.idxs

Description

Plot factor correlations for the specified w.idxs

Usage

list(list("plot"), list("factor.correlations"))(
  factors = NULL,
  w.idxs = NULL,
  data = "train",
  cv = FALSE,
  method = "spearman",
  label = "x",
  sig.cutoff = 0.05
)

Arguments

Argument |Description ------------- |---------------- factors | Which factors to return features for? Accepts integers (i.e. factors = c(1,2,4) or factors = 1) Defaults to NULL (all). w.idxs | Which w.idxs (models) to use? Accepts integers (i.e. w.idxs = c(1,2,4) or w.idxs = 1) Defaults to NULL (all). data | Which dataset to use? Can be any dataset listed under $data$____. Defaults to "train". cv | If data = "train", get factor scores generated from $run.cv.spear? If $run.spear was used or if data != "train" this parameter is ignored. Defaults to TRUE. method | Which correlation method to use? Defaults to spearman. Accepts spearman, pearson, and kendall. label | How to label/distinguish factors per model? Defaults to x (label with w.x). Accepts x, y, xy, idx, all. sig.cutoff | When to plot an asterisk (*)? Will plot if p.value from cor.test is <= sig.cutoff. Defaults to .05



jgygi/SPEAR documentation built on July 5, 2023, 5:35 p.m.