selfCorrelation: Self Correlation

In VEuPathDB/veupathUtils: General Helper Functions for VEuPathDB Projects

Self Correlation

Description

This function returns correlation coefficients for variables in one dataset against itself

Usage

selfCorrelation(
  data,
  method = c("spearman", "pearson", "sparcc"),
  format = c("ComputeResult", "data.table"),
  verbose = c(TRUE, FALSE),
  ...
)

## S4 method for signature 'data.table'
selfCorrelation(
  data,
  method = c("spearman", "pearson"),
  format = c("ComputeResult", "data.table"),
  verbose = c(TRUE, FALSE)
)

## S4 method for signature 'Collection'
selfCorrelation(
  data,
  method = c("spearman", "pearson"),
  format = c("ComputeResult", "data.table"),
  verbose = c(TRUE, FALSE),
  proportionNonZeroThreshold = 0.05,
  varianceThreshold = 0,
  stdDevThreshold = 0
)

## S4 method for signature 'SampleMetadata'
selfCorrelation(
  data,
  method = c("spearman", "pearson"),
  format = c("ComputeResult", "data.table"),
  verbose = c(TRUE, FALSE)
)

Arguments

data	A data.table or Collection object.
method	string defining the type of correlation to run. The currently supported values are 'spearman','pearson', and for some methods/ data types 'sparcc'.
format	string defining the desired format of the result. The currently supported values are 'data.table' and 'ComputeResult'.
verbose	boolean indicating if timed logging is desired

Value

ComputeResult object

VEuPathDB/veupathUtils documentation built on Feb. 8, 2025, 12:29 p.m.