Last data update: 2014.03.03

R: CorrData class
CorrDataR Documentation

CorrData class

Description

Package: IdMappingAnalysis
Class CorrData

Object
~~|
~~+--CorrData

Directly known subclasses:

public static class CorrData
extends Object

CorrData object stores the pair of experiments on which the correlation related processing is performed (MS/MS and mRNA for example) in such a way that two experiments are aligned by experiment names and by the primary keys ensuring the fast correlations. Typically, the primary ID of the ID Map set under consideration is a primary key for a first experiment, and the secondary ID if the ID Map set is a primary key for a second experiment. The alignment of two experiments by primary keys is guaranteed by using the unique pairs object to produce a matching pair of primary keys on which both experiments are ordered. Represented by a list of two elements with names corresponding to the primary and secondary IDs of the unique pairs ('acc' and 'probeset' for example), each element containing a data frame with primary or secondary IDs in the first column while the rest of columns contain the experiment data. The names of the data columns in both data frames are identical and correspond to the sample IDs. The match of sample IDs and an alignment by primary/secondary IDs is ensured by the proper processing during the object creation.

Usage

CorrData(uniquePairs=NULL, expSet1=NULL, expSet2=NULL, verbose=FALSE, ...)

Arguments

uniquePairs

UniquePairs object or a list of such objects on which a single or a list of CorrData objects is constructed.

expSet1

a first ExperimentSet object with primary IDs corresponding (partially intersecting) with the content the first column of UniquePairs (uniquePairsData) object.

expSet2

a second ExperimentSet object with primary IDs corresponding (partially intersecting) with the content the second column of UniquePairs (uniquePairsData) object.

verbose

if TRUE enables diagnostic messages. Default is FALSE.

...

Not used.

Fields and Methods

Methods:

as.MultiSet Convert CorrData object into MultiSet object.
getExperimentSet Get experiment set data frame for a given modality.
getSampleNames Get experiment sample names.
getUniquePairs Extract unique pairs from the CorrData object.
interactive.plot Draw a scatterplot of experiment data interactively.
plot Scatterplot of experiment data.
primaryKey Retrieves a primary key for a given CorrData object.
secondaryKey Retrieves a secondary key for a given CorrData object.

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

 corrData<-CorrData(examples$uniquePairs,
		examples$msmsExperimentSet,examples$mrnaExperimentSet,verbose=TRUE);
 class(corrData);
 

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(IdMappingAnalysis)
Loading required package: R.oo
Loading required package: R.methodsS3
R.methodsS3 v1.7.1 (2016-02-15) successfully loaded. See ?R.methodsS3 for help.
R.oo v1.20.0 (2016-02-17) successfully loaded. See ?R.oo for help.

Attaching package: 'R.oo'

The following objects are masked from 'package:methods':

    getClasses, getMethods

The following objects are masked from 'package:base':

    attach, detach, gc, load, save

Loading required package: rChoiceDialogs
Loading required package: rJava

Attaching package: 'rJava'

The following object is masked from 'package:R.oo':

    clone

This is rChoiceDialogs 1.0.6 2014-09-05
This is IdMappingAnalysis 1.16.0 2013-05-24
> png(filename="/home/ddbj/snapshot/RGM3/R_BC/result/IdMappingAnalysis/CorrData.Rd_%03d_medium.png", width=480, height=480)
> ### Name: CorrData
> ### Title: CorrData class
> ### Aliases: CorrData
> ### Keywords: classes
> 
> ### ** Examples
> 
>  corrData<-CorrData(examples$uniquePairs,
+ 		examples$msmsExperimentSet,examples$mrnaExperimentSet,verbose=TRUE);
extracting subset by row names...
extracting subset by row names...
extracting subset by column names...
extracting subset by column names...
Creating data structure for correlations...
>  class(corrData);
[1] "CorrData" "Object"  
>  
> 
> 
> 
> 
> dev.off()
null device 
          1 
>