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

loveR

annotationConvertor(HTSanalyzeR)
annotationConvertor()所属R语言包：HTSanalyzeR

                                         Convert between different types of gene identifiers
                                         基因标识不同类型之间转换

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

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

This function converts an initial named data vector to the same vector but  with a different identifier category, and removes the genes for which no  mapping were found. This function can also take a matrix, with gene  identifiers as row names.
此功能最初命名的数据向量转换到同一向量，但用不同的标识符类别，并删除没有映射被发现的基因。此功能也可以采取一个矩阵，行名称基因标识。


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


annotationConvertor(geneList, species="Dm", initialIDs="Entrez.gene",
finalIDs="Entrez.gene", keepMultipleMappings=TRUE, verbose=TRUE)



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

参数：geneList
a named integer or numeric vector, or a matrix with rows named by gene  identifiers  
一个名为基因标识命名的行的整数或数字向量或矩阵


参数：species
a single character value specifying the species for which the data should  be read. The current version supports one of the following species: "Dm"  ("Drosophila_melanogaster"), "Hs" ("Homo_sapiens"), "Rn" ("Rattus_norvegicus"),  "Mm" ("Mus_musculus") and "Ce" ("Caenorhabditis_elegans").         
一个单一的字符值，指定读取数据应种。当前版本支持以下种类之一：“DM”（“Drosophila_melanogaster”），“HS”（“Homo_sapiens”），“RN”（的“Rattus_norvegicus”），“MM”（“ mus_musculus“）和”CE“（”Caenorhabditis_elegans“）。


参数：initialIDs
a single character value specifying the type of initial identifiers for  input 'geneList'. Current version can take one of the following types:  "Ensembl.transcript", "Ensembl.prot", "Ensembl.gene", "Entrez.gene",  "RefSeq", "Symbol" and "GenBank" for all supported species; "Flybase",  "FlybaseCG" and "FlybaseProt" in addition for Drosophila Melanogaster;  "wormbase" in addition for Caenorhabditis Elegans.   
一个单一的字符值，指定类型为输入“geneList”的初始标识。当前版本可以采取以下几种类型之一：“Ensembl.transcript”，“Ensembl.prot”，“Ensembl.gene”，“Entrez.gene”，“的RefSeq”，“符号”和“ GenBank中“为所有受支持的物种”果蝇“，”FlybaseCG“和”FlybaseProt“除了在果蝇;”wormbase“除了线虫。


参数：finalIDs
a single character value specifying the type of initial identifiers for  input 'geneList'. Current version can take one of the following types:  "Ensembl.transcript", "Ensembl.prot", "Ensembl.gene", "Entrez.gene",  "RefSeq", "Symbol" and "GenBank" for all supported species; "Flybase",  "FlybaseCG" and "FlybaseProt" in addition for Drosophila Melanogaster;  "wormbase" in addition for Caenorhabditis Elegans.   
一个单一的字符值，指定类型为输入“geneList”的初始标识。当前版本可以采取以下几种类型之一：“Ensembl.transcript”，“Ensembl.prot”，“Ensembl.gene”，“Entrez.gene”，“的RefSeq”，“符号”和“ GenBank中“为所有受支持的物种”果蝇“，”FlybaseCG“和”FlybaseProt“除了在果蝇;”wormbase“除了线虫。


参数：keepMultipleMappings
a single logical value. If TRUE, the function keeps the entries with  multiple mappings (first mapping is kept). If FALSE, the entries with  multiple mappings will be discarded.  
一个单一的逻辑值。如果为TRUE，函数保持多个映射（保持第一的映射）的条目。如果为FALSE，多个映射条目将被丢弃。


参数：verbose
a single logical value specifying to display detailed messages (when  verbose=TRUE) or not (when verbose=FALSE)  
一个逻辑值，指定显示详细消息（VERBOSE = TRUE时）或（当VERBOSE = FALSE）


Details

详情----------Details----------

The entries that could not be mapped to any identifiers are removed from  the resulting data vector/matrix. This function relies on the org.Dm.eg.dbpackage and therefore only maps
从得到的数据向量/矩阵不能被映射到任何标识的条目被删除。这个函数依赖于的org.Dm.eg.dbpackage，因此只有图

from any identifier to an Entrez gene id, or
Entrez基因身份证，或从任何标识

from an Entrez gene ID to any identifier       
从Entrez基因身份证到任何标识符


值----------Value----------

the same data vector/matrix but with names/row names converted.
相同的数据矢量/矩阵，但名称/行名称转换。


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



Xin Wang, Camille Terfve




参见----------See Also----------

mammalAnnotationConvertor, celAnnotationConvertor, drosoAnnotationConvertor
mammalAnnotationConvertor，celAnnotationConvertor，drosoAnnotationConvertor


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


library(org.Dm.eg.db)
##example 1: convert a named vector[＃例子1：一个名为矢量转换]
x<-runif(10)
names(x)<-names(as.list(org.Dm.egSYMBOL2EG))[1:10]
xEntrez<-annotationConvertor(geneList=x, species="Dm", initialIDs="Symbol",
finalIDs="Entrez.gene")
##example 2: convert a data matrix with row names as gene ids[＃示例2：数据矩阵转换与基因IDS行名称]
x<-cbind(runif(10),runif(10))
rownames(x)<-names(as.list(org.Dm.egSYMBOL2EG))[1:10]
xEntrez<-annotationConvertor(geneList=x, species="Dm", initialIDs="Symbol",
finalIDs="Entrez.gene")

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


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