getCorrDataFrame.JointUniquePairs {IdMappingAnalysis} | R Documentation

## Merge JointUniquePairs and Corr objects into a single data frame

### Description

This is a convinience function allowing to derive a data frame from the JointUniquePairs and Corr object. The structure of the resulting data frame is similar to the one of JointUniquePairs object, but `logical` values indicating the presence of the given match pair for a particular ID Map are replaced whith correlation values from Corr object if the `logical` value is `TRUE` or by `NA` 's otherwise. Note, that the Corr object should correspond to the union of all ID Maps in consideration, i.e. should represent a full group.

### Usage

    ## S3 method for class 'JointUniquePairs'
    getCorrDataFrame(this, corr, groups=NULL, full.group=FALSE, verbose=FALSE, ...)

### Arguments

`corr` | Corr object from which the Corr object(s) retrieved for each particular DB based on which the patricular Corr object is retrieved.
`groups` | Optional `list` of DB names from the JointUniquePairs object defining the set of match groups to be used for retrieving the corresponding Corr objects. If `NULL`, all match groups within the JointUniquePairs object are used.
`full.group` | Determines if the resulting Corr object `list` should represent a full group. Default is `FALSE`.
`verbose` | if `TRUE` enables diagnostic messages. Default is `FALSE`.
`...` | Not used

### Value

A `data.frame` similar to the one encapsulated wwithin the JointUniquePairs object, but the `logical` values indicating the presence of the given match pair for a particular ID Map are replaced by correlation values from Corr object if the `logical` value is `TRUE` or by `NA` 's otherwise.

### Author(s)

Alex Lisovich, Roger Day

### See Also

For more information see `JointUniquePairs`.

### Examples

     corrDF<- examples$jointUniquePairs$getCorrDataFrame(examples$corr,
    	groups=c("NetAffx_Q", "DAVID_Q", "EnVision_Q"),
         full.group=FALSE, verbose=TRUE);
     corrDF[1:10,];

[Package IdMappingAnalysis version 1.24.0 Index]