CorrelationMatrix: 'CorrelationMatrix'

View source: R/covariancecorrelation.R

CorrelationMatrixR Documentation

CorrelationMatrix

Description

Produces a correlation matrix from columns of data.

Usage

CorrelationMatrix(
  input.data,
  use.names = FALSE,
  ignore.columns = "",
  missing.data = "Use partial data",
  spearman = FALSE,
  filter = NULL,
  weights = NULL,
  show.cell.values = "Automatic",
  colors = NULL,
  colors.min.value = -1,
  colors.max.value = 1,
  row.labels = "Yes",
  column.labels = "Yes",
  input.type = NULL,
  categorical.as.binary = FALSE
)

Arguments

input.data

Either a data.frame, a list of data.frames and/or vectors, or a matrix.

use.names

Whether to use names in place of labels.

ignore.columns

A list of names of columns to ignore. When input.data is a matrix, rows are also ignored. Typically c("NET", "Total", "SUM").

missing.data

Treatment of missing data. Options are "Use partial data", "Error if missing data", or "Exclude cases with missing data".

spearman

Boolean whether to compute Spearman's correlation instead of Pearson's correlation.

filter

An optional logical vector specifying a subset of values to be used.

weights

An optional vector of sampling weights.

show.cell.values

Either "Yes", "No" or "Automatic". "Automatic" displays values if there are <= 10 rows in the matrix.

colors

A vector of colors used to create the colorbar. If not specified it will default to RdBu from colorbrewer.

colors.min.value

Lower bound of the colorbar

colors.max.value

Upper bound of the colorbar

row.labels

Either "Yes" or "No" indicating whether row labels should be displayed.

column.labels

Either "Yes" or "No" indicating whether row labels should be displayed.

input.type

Deprecated. Now automatically deduced from input.data.

categorical.as.binary

Whether to convert factors to dummy binary variables, or else their levels are converted to integers.


Displayr/flipStatistics documentation built on April 12, 2024, 4:15 a.m.