AnnotationEnvision: The AnnotationEnvision class

In professorbeautiful/IdMappingRetrieval: ID Mapping Data Retrieval

Description

Package:
Class AnnotationEnvision

Object
~~|
~~+--Annotation
~~~~~~~|
~~~~~~~+--AnnotationEnvision

Directly known subclasses:

public static class AnnotationEnvision
extends Annotation

The AnnotationEnvision class encapsulates the functionality allowing to retrieve data from the Envision online query system.The Envision online query system allows to retrieve the ID matching information accompanied by multiple attributes like species and the microarray chip type in the form of the xml file. The AnnotationEnvision class encapsulates the functionality allowing to filter the Envision query results on species and microarray type attributes and convert it into a data frame during the getIdMap() and getDataFrame() calls on the AnnotationEnvision object.

Usage

AnnotationEnvision(cacheFolderName="EnVision", primaryColumn=c("UniProt.SwissProt.Accession", "UniProt.TrEMBL.Accession"), secondaryColumn=NA, swap=TRUE, species="Homo sapiens", full.merge=TRUE, ...)

Arguments

cacheFolderName	The symbolic name of a service represented by a given AnnotationEnsembl object.
primaryColumn	Primary column(s) to be retrieved from a data frame obtained from the Ensembl csv file when getIdMap() is called. As the Ensembl returns the match results for SwissProt and Tremb accessions in separate columns, it is possible to retrieve either or them or merge them together by explicetely specifying the set of columns to be merged. Default is c('uniprot_swissprot_accession','uniprot_sptrembl').
secondaryColumn	secondaryColumn Secondary column (containing probeset IDs) to be retrieved from a data frame obtained from the Ensembl csv file when getIdMap() is called. If NA (default), the column name(s) derived automatically from the array type parameter during the getDataFrame() call. It should be noted that the probeset ID column name in Ensembl data format is array specific ('Affy.HG.U133.PLUS.2' for example) and therefore needs to be selected on per array basis if specified explicitely.
swap	A logical indicating if primary and secondary column(s) need to be swapped at the end of the IdMap retrieval during the getIdMap() call.Default is TRUE.
species	Character vector or NA indicating if filtering of the results on a particular set of species should be performed if a given service provides the species information. If NA, no filtering is performed. Default is 'Homo sapiens'.
full.merge	A logical indicating which version of primary columns merging algorithm to use. If TRUE (default), all unique pairs <probeset ID, SwissProt> and <probeset ID, Trembl> are generated, and if FALSE, only those pairs from <probeset ID, Trembl> for which Uniparot ID is not present in <probeset ID, SwissProt> pairs are included.
...	Additional parameters, see Annotation.

Fields and Methods

Methods:
No public methods defined.

Methods inherited from Annotation:
getArrayType, getArrayTypes, getColumns, getCredentials, getDataFrame, getFolderName, getIdMap, getRoot, getServiceRoot, init, readDF, setCredentials, setOptions

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

Author(s)

Alex Lisovich, Roger Day

Examples

## Not run: 
 Annotation$init();
 #create Envision annotation object
 annObj<-AnnotationEnvision(species="Homo sapiens");

## End(Not run)

professorbeautiful/IdMappingRetrieval documentation built on May 26, 2019, 8:33 a.m.