Corr {IdMappingAnalysis} | R Documentation

## The Corr class

### Description

Package: IdMappingAnalysis
Class Corr

`Object`
`~~|`
`~~+--``IdMapBase`
`~~~~~~~|`
`~~~~~~~+--``Corr`

Directly known subclasses:

public static class Corr
extends IdMapBase

Create the Corr object by performing correlations on the CorrData object using the correlation algorithm defined by the method argument. The Corr object encapsulates a `data.frame` containing three columns: the first two are unique pairs and the third is a correlation results with a column name reflecting the correlation method ('pearson', 'spearman' or 'kendall').

### Usage

    Corr(corrData=NULL, method="pearson", verbose=FALSE, ...)

### Arguments

`corrData` | CorrData object on which correlation is performed or a `data.frame` compliant with the Corr object internal data frame format.
`method` | Correlation method ('pearson', 'spearman' or 'kendall'). Default is 'pearson'.
`verbose` | if `TRUE` enables diagnostic messages. Default is `FALSE`.
`...` | Not used.

### Fields and Methods

Methods:

| `getData` | Extract correlation results from the Corr object.
| `getUniquePairs` | Extract unique pairs from the Corr object.
| `plot` | Plot the density distributions for correlation object(s).

Methods inherited from IdMapBase:
[, aligned, as.data.frame, dim, dimnames, getName, primaryIDs, primaryKey, secondaryKey

Methods inherited from Object:
$, $<-, [[, [[<-, as.character, attach, attachLocally, clearCache, clearLookupCache, clone, detach, equals, extend, finalize, gc, getEnvironment, getFieldModifier, getFieldModifiers, getFields, getInstantiationTime, getStaticInstance, hasField, hashCode, ll, load, objectSize, print, registerFinalizer, save

### Author(s)

Alex Lisovich, Roger Day

### Examples

     corr<-Corr(examples$corrData,method="spearman",verbose=TRUE);
     class(corr);
     corr[1:10,];

[Package IdMappingAnalysis version 1.28.0 Index]