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

loveR

getANNOTATION(annotationTools)
getANNOTATION()所属R语言包：annotationTools

                                        General annotation function
                                         一般注释功能

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

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

Takes a vector of identifiers and an annotation table and matches the identifiers in the table to retrieve the corresponding annotation. Only the first occurence of each identifier in the annotation table is considered.
需要一个向量标识符和注释表和表中的标识符匹配，获取相应的注释。只被认为是第一次出现的注释表中的每个标识符。


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


getANNOTATION(identifier, annot, diagnose = FALSE, identifierCol = 1, annotationCol = 15, noAnnotationSymbol = NA, noAnnotationProvidedSymbol = "---", sep = " /// ")



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

参数：identifier
vector containing identifiers to be annotated.
向量标识符注明。


参数：annot
annotation table (data frame) where each row is a record and each column is an annotation field.
注释表（数据框），每一行是一个记录和每一列是一个注释字段。


参数：diagnose
logical. If TRUE, 3 (logical) vectors used for diagnostic purpose are returned in addition to the annotation. If FALSE (default) only the annotation is returned.
逻辑。如果是TRUE，返回3（逻辑）用于诊断目的的向量在另外的注解。如果为FALSE（默认）的注释，则返回。


参数：identifierCol
column in annotation table where the provided identifiers are to be looked up.
注释表中的列提供的标识符要抬起头来。


参数：annotationCol
column in annotation table containing the desired annotation.
列中包含所需的注解注释表。


参数：noAnnotationSymbol
character string to be used in output list 'annotation' if no annotation is found or provided.
字符串被用来在输出列表“注释”，如果没有被发现或提供注解。


参数：noAnnotationProvidedSymbol
character string used in annotation table and indicating missing annotation.
字符串用于注释表表明失踪注释。


参数：sep
character string used in annotation table to separate multiple annotation of a single identifier.
注释表中用来分隔一个单一的标识符的多个注释字符串。


Details

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

The annotation is returned as elements of list 'annotation'. If a single annotation is given for a particular identifier, the corresponding element of 'annotation' has length 1. If multiple annotation is provided for a single identifier (i.e. character string with 'sep' separating multiple annotations), the mulitple annotation is split and the corresponding vector is returned as an element of list 'annotation'.
注释返回列表“注释”的元素。如果是为一个特定的标识符给一个单一的注解，“注释”的相应元素的长度为1。如果有多个注解提供一个单一的标识符（即九月分隔多个批注字符串），被分成多张注释和对应的向量作为返回列表“注释”中的一个元素。


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


参数：annotation
list of length 'length(identifier)' the 'i'-th element of which contains the annotation for 'identifier[i]'.
长度长度（标识符）“列表”δ-th元素，其中包含了注释标识符[I]“。


参数：empty
logical vector of length 'length(identifier)'. 'empty[i]' is TRUE if 'identifier[i]' is empty or NA.
逻辑矢量长度的长度（标识符）“。 “空[I]TRUE标识符[I]”如果是空的或NA。


参数：noentry
locial vector of length 'length(identifier)'. 'noentry[i]' is TRUE if 'identifier[i]' cannot be found in 'annot[,identifierCol]'.
locial向量长度的长度（标识符）“。 “NOENTRY [I]”为TRUE，如果“标识[I]”不能被发现在“annot，identifierCol]”。


参数：noannotation
locial vector of length 'length(identifier)'. 'noannotation[i]' is TRUE if 'a[i]==noAnnotationProvidedSymbol' is TRUE.
locial向量长度的长度（标识符）“。 “noannotation [I]”为TRUE，如果“一个[我] == noAnnotationProvidedSymbol的是TRUE。


注意----------Note----------

Use getMULTIANNOTATION if the identifiers occur on more than one line in the annotation table.
使用getMULTIANNOTATION的标识符，如果出现多个注释表中的行。


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


Alexandre Kuhn



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

getMULTIANNOTATION
getMULTIANNOTATION


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


##example annotation table[＃例如注解表]
annotation<-cbind(gene=c('gene_1a, gene_1b','gene_2','gene_3','gene_4'),probe=c('probe_1','probe_2','probe_3','probe_4'),sequence=c('sequence_1','sequence_2a, sequence_2c','sequence_3',''))
print(annotation)

##get sequences for probe_2, probe_3, probe_4 and probe_100[＃序列probe_2，probe_3，probe_4和probe_100]
myProbes<-c('probe_2','probe_3','probe_4','probe_100',NA)
getANNOTATION(myProbes,annotation,identifierCol=2,annotationCol=3,noAnnotationProvidedSymbol='',sep=', ')

##track origin of annotation failure for the last 3 probes[＃注释失败的起源，在过去的3探针跟踪]
getANNOTATION(myProbes,annotation,identifierCol=2,annotationCol=3,noAnnotationProvidedSymbol='',sep=', ',diagnose=TRUE)

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


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