R语言 IdMappingRetrieval包 AnnotationEnsembl()函数中文帮助文档(中英文对照)

loveR

AnnotationEnsembl(IdMappingRetrieval)
AnnotationEnsembl()所属R语言包：IdMappingRetrieval

                                        The AnnotationEnsembl class
                                         AnnotationEnsembl类

                                         译者：生物统计家园网 机器人LoveR

描述----------Description----------

Package:   <br> Class AnnotationEnsembl<br>
包装方式：参考的类AnnotationEnsembl参考

Object<br> ~~|<br> ~~+--Annotation<br> ~~~~~~~|<br> ~~~~~~~+--AnnotationEnsembl<br>
Object参考~~|参考~~+--  Annotation参考~~~~~~~|参考~~~~~~~+--  AnnotationEnsembl参考

Directly known subclasses:<br> AnnotationEnsemblCsv<br>
直接已知子类：AnnotationEnsemblCsv参考参考

public static class AnnotationEnsembl<br> extends Annotation<br>
公共静态的类AnnotationEnsembl参考延伸注释参考

The AnnotationEnsembl class encapsulates the functionality allowing to retrieve data from the Ensembl BioMart online query system using biomaRt R package through the Annotation.getIdMap() and Annotation.getDataFrame() calls on this object.
AnnotationEnsembl类封装的功能，允许从Ensembl的BioMart在线查询系统使用通过这个对象调用的Annotation.getIdMap（）和Annotation.getDataFrame（）biomaRt R包中检索数据。


用法----------Usage----------


AnnotationEnsembl(cacheFolderName="Ensembl", primaryColumn=c("uniprot_swissprot_accession", "uniprot_sptrembl"), secondaryColumn=NA, swap=FALSE, species="hsapiens_gene_ensembl", full.merge=TRUE, ...)



参数----------Arguments----------

参数：cacheFolderName
The symbolic name of a service represented by a given AnnotationEnsembl object.
符号名称的由代表某一AnnotationEnsembl对象的服务。


参数：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').
从Ensembl的csv文件，当getIdMap（）被称为“所得的数据框（S）进行检索主列。 Ensembl的返回SwissProt和分隔列Tremb的加入，比赛的结果，它可以检索或者他们合并在一起通过explicetely指定要合并的列集。默认是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.
从Ensembl的csv文件，当getIdMap（）被称为“所得的数据框进行检索的secondaryColumn中学列（含probeset的ID）。如果NA（默认），列名（S）来自数组类型参数的过程中自动getDataFrame（）调用。应当指出在Ensembl的数据格式，probeset编号列名是阵列中的特定（Affy.HG.U133.PLUS.2例如），因此需要在每个阵列的基础上，如果选择显式地指定。


参数：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.
一个logical如果需要交换的idMap检索在getIdMap（小学和中学列（S））call.Default是：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 'hsapiens_gene_ensembl'.
应进行特征向量或NA如果结果表明过滤一套特定的物种，如果一个特定的服务提供了物种的信息。如果NA，没有过滤的。默认是hsapiens_gene_ensembl“。


参数：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 Uniprot ID is not present in <probeset ID, SwissProt> pairs are included.
一个logical表明初级列的版本合并使用的算法。如果@ True（默认），所有的独特的双<probeset ID, SwissProt>和<probeset ID, Trembl>产生，如果FALSE，只有那些从<probeset的的双ID, Trembl> Uniprot ID是没有<probeset ID, SwissProt>对。


参数：...
Additional parameters, see Annotation.
额外的参数，请参阅Annotation。


字段和方法----------Fields and Methods----------

Methods:<br> No public methods defined.
方法：参考没有定义的公共方法。

Methods inherited from Annotation:<br> getArrayType, getArrayTypes, getColumns, getCredentials, getDataFrame, getFolderName, getIdMap, getRoot, getServiceRoot, init, readDF, setCredentials, setOptions
方法继承注释：的参考getArrayType，getArrayTypes，调用getColumns，getCredentials，getDataFrame，getFolderName，getIdMap，getRoot，getServiceRoot，初始化，readDF，setCredentials，setOptions

Methods inherited from Object:<br> $, $<-, [[, [[<-, as.character, attach, attachLocally, clearCache, clone, detach, equals, extend, finalize, gc, getEnvironment, getFields, getInstantiationTime, getStaticInstance, hasField, hashCode, ll, load, objectSize, print, registerFinalizer, save
从Object继承的方法：参考$，$ < -  [[[[< -  as.character，附加，attachLocally，clearCache，克隆，分离，等于，扩展，定型，GC，getEnvironment，getFields， getInstantiationTime，getStaticInstance，hasField的hashCode，LL，负载，objectSize，打印，registerFinalizer，功能save


作者（S）----------Author(s)----------


Alex Lisovich, Roger Day



举例----------Examples----------


## Not run: [＃无法运行：]
Annotation$init();
#create Ensembl annotation object[创建Ensembl的注解对象]
annObj<-AnnotationEnsembl(species="hsapiens_gene_ensembl");


转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。


注：
注1：为了方便大家学习，本文档为生物统计家园网机器人LoveR翻译而成，仅供个人R语言学习参考使用，生物统计家园保留版权。
注2：由于是机器人自动翻译，难免有不准确之处，使用时仔细对照中、英文内容进行反复理解，可以帮助R语言的学习。
注3：如遇到不准确之处，请在本贴的后面进行回帖，我们会逐渐进行修订。