selfCorrelation-SampleMetadata-method: Self Correlation

selfCorrelation,SampleMetadata-methodR Documentation

Self Correlation

Description

This function returns correlation coefficients for variables in one SampleMetadata object against itself

Usage

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

Arguments

data

SampleMetadata object

method

string defining the type of correlation to run. The currently supported values are 'spearman', 'pearson' and '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/microbiomeComputations documentation built on March 1, 2024, 7:21 a.m.