BSkyPlotCorrelationMatrix: Correlation Analysis

BSkyPlotCorrelationMatrixR Documentation

Correlation Analysis

Description

This function uses the rcorr function in the Hmisc package to compute matrices of Pearson or Spearman correlations along with the pair wise p-values among the correlations. The p-values are corrected for multiple inference using Holm's method (see p.adjust). Observations are filtered for missing data, and only complete observations are used.

Usage

BSkyPlotCorrelationMatrix(
  data,
  vars = NULL,
  correlationType = "Pearson",
  missingValues = "complete.obs",
  visualizeCorrelation = TRUE,
  plotWeb = TRUE
)

Arguments

data

a numeric matrix or data frame, or an object of class "rcorr.adjust" to be printed.

correlationType

"pearson" or "spearman", depending upon the type of correlations desired; the default is "pearson".

missingValues

how to handle missing data: "complete.obs", the default, use only complete cases; "pairwise.complete.obs", use all cases with valid data for each pair.

visualizeCorrelation

prints PlotCorr()

plotWeb

prints PlotWeb()

Value

Returns an object of class "rcorr.adjust", which is normally just printed.


BlueSkyStatistics/BlueSky documentation built on April 14, 2025, 7:39 a.m.