correl2Comp: correl2Comp

Description Usage Arguments Details Value Author(s)

View source: R/compareAnalysis.R

Description

This function computes the correlation between two components.

Usage

1
2
correl2Comp(comp1, comp2, type.corr = "pearson", plot = FALSE, 
    cutoff_zval = 0, test = FALSE, alreadyTreat = FALSE)

Arguments

comp1

The first component, a vector of projections or contributions indexed by labels

comp2

The second component, a vector of projections or contributions indexed by labels

type.corr

Type of correlation to be computed, either 'pearson' or 'spearman'

plot

if TRUE, plot comp1 vs comp2

cutoff_zval

either NULL or 0 (default) if all genes are used to compute the correlation between the components, or a threshold to compute the correlation on the genes that have at least a scaled projection higher than cutoff_zval.

test

if TRUE the correlation test p-value is returned instead of the correlation value

alreadyTreat

if TRUE comp1 and comp2 are considered as being already treated (i.e scaled and restricted to common elements)

Details

Before computing the correlation, the components are scaled and restricted to common labels. When cutoff_zval is different from 0, the elements that are included in the circle of center 0 and radius cutoff_zval are not taken into account during the computation of the correlation.

Value

This function returns either the correlation value or the p-value of the correlation test.

Author(s)

Anne Biton


Bioconductor-mirror/MineICA documentation built on May 29, 2017, 8:30 a.m.