rMatrix: Correlation matrix

In rosetta: Parallel Use of Statistical Packages in Teaching

Correlation matrix

Description

rMatrix provides a correlation matrix with confidence intervals and a p-value adjusted for multiple testing.

Usage

rMatrix(
  dat,
  x,
  y = NULL,
  conf.level = 0.95,
  correction = "fdr",
  digits = 2,
  pValueDigits = 3,
  colspace = 2,
  rowspace = 0,
  colNames = "numbers"
)

## S3 method for class 'rMatrix'
print(
  x,
  digits = x$digits,
  pValueDigits = x$pValueDigits,
  colNames = x$colNames,
  ...
)

Arguments

dat	A dataframe containing the relevant variables.
x	Vector of 1+ variable names.
y	Vector of 1+ variable names; if this is left empty, a symmetric matrix is created; if this is filled, the matrix will have the x variables defining the rows and the y variables defining the columns.
conf.level	The confidence of the confidence intervals.
correction	Correction for multiple testing: an element out of the vector c("holm", "hochberg", "hommel", "bonferroni", "BH", "BY", "fdr", "none"). NOTE: the p-values are corrected for multiple testing; The confidence intervals are not (yet :-)).
digits	With what precision do you want the results to print.
pValueDigits	Determines the number of digits to use when displaying p values. P-values that are too small will be shown as p<.001 or p<.00001 etc.
colspace	Number of spaces between columns
rowspace	Number of rows between table rows (note: one table row is 2 rows).
colNames	colNames can be "numbers" or "names". "Names" cause variables names to be printed in the heading; "numbers" causes the rows to become numbered and the numbers to be printed in the heading.
...	Additional arguments are ignored.

Details

rMatrix provides a symmetric or asymmetric matrix of correlations, their confidence intervals, and p-values. The p-values can be corrected for multiple testing.

Value

An rMatrix object that when printed shows the correlation matrix

An object with the input and several output variables. Most notably a number of matrices:

r	Pearson r values.
parameter	Degrees of freedom.
ci.lo	Lower bound of Pearson r confidence interval.
ci.hi	Upper bound of Pearson r confidence interval.
p.raw	Original p-values.
p.adj	p-values adjusted for multiple testing.

Author(s)

Gjalt-Jorn Peters

Maintainer: Gjalt-Jorn Peters [e-mail]

Examples

rMatrix(mtcars, x=c('disp', 'hp', 'drat'))

rosetta documentation built on March 7, 2023, 7:40 p.m.