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

loveR

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

                                        Find gene symbols
                                         基因符号

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

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

Takes a vector of probe set identifiers and an annotation table and retrieves the corresponding gene symbols.
注意到向量的探针集标识符和注释表检索相应的基因符号。


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


getGENESYMBOL(ps, annot, diagnose = FALSE, GScol = 15, noGSsymbol = NA, noGSprovidedSymbol = "---", sep = " /// ")



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

参数：ps
character vector containing the probe sets identifiers.
特征向量包含探针设置标识符。


参数：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（默认）的注释，则返回。


参数：GScol
column in annotation table containing the gene IDs.
注释包含的基因标识的表列。


参数：noGSsymbol
character string to be used in output list 'symbols' if no gene symbol is found or provided in the annotation table.
在输出列表“符号”的字符串用于基因的象征，如果没有被发现或注释表中提供的。


参数：noGSprovidedSymbol
character string used in annotation table and indicating missing gene symbol.
字符串表注释和说明缺少的基因符号。


参数：sep
character string used in annotation table to separate multiple gene symbols.
注释表字符串分隔多个基因符号。


Details

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

This function can be used with Affymetrix annotation files (e.g. 'HG-U133\_Plus\_2\_annot.csv'). It retrieves the gene symbols corresponding to particular probe set identifiers.
此功能可用于与Affymetrix的注释文件（例如，“HG-U133 \ _Plus \ _2的\ _annot.csv”）。它检索特定的探针集标识符对应的基因符号。

Gene symbols are returned as elements of list 'symbols'. If multiple gene symbols are provided for 'ps[i]' (with 'sep' separating gene symbols in the annotation table), a vector containing all gene symbols is returned as the 'i-th' element of list 'symbols'.
基因符号返回列表符号元素。如果多个基因符号为“PS [I]”（“九月”分离基因符号的注释表），返回包含所有基因符号矢量“第i名单符号的元素。

The default values for 'GScol', 'noGSsymbol', 'noGSprovidedSymbol' and 'sep' are chosen to suit the format of Affymetrix annotation files. However, these options can be set to look up any annotation table, provided the probe set identifiers are in the first column and occur only once.
“GScol，noGSsymbol，noGSprovidedSymbol”和“九月”的默认值选择适合Affymetrix的注释文件的格式。然而，这些选项可以设置查找任何注释表，提供探针集标识符是在第一列，只发生一次。


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


参数：symbols
list of length 'length(ps)' the 'i'-th element of which contains the gene symbol for 'ps[i]'.
列表的长度的长度（PS），δ-th元素，其中包含的基因符号“PS [I]。


参数：empty
logical vector of length 'length(ps)'. 'empty[i]' is TRUE if 'ps[i]' is empty or NA.
逻辑矢量长度的长度（PS）。 “空[I]”为TRUE，如果“PS [我]为空或NA。


参数：noentry
locial vector of length 'length(ps)'. 'noentry[i]' is TRUE if 'ps[i]' cannot be found in the first column of the annotation table.
locial向量长度的长度（PS）。 “NOENTRY [I]”为TRUE，如果“PS我不能在第一列的注释表。


参数：nogs
locial vector of length 'length(ps)'. 'nogs[i]' is TRUE if 'symbols[i]==noIDprovidedSymbol' is TRUE.
locial向量长度的长度（PS）。 “nogs [I]是TRUE，如果符号[I] == noIDprovidedSymbol”为TRUE。


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

getANNOTATION provides a more flexible solution to be used with arbitrary annotation tables.
getANNOTATION提供了更加灵活的解决方案，将用于与任意注释表。


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


Alexandre Kuhn



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

getANNOTATION
getANNOTATION


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


##example Affymetrix annotation file and its location[＃例如Affymetrix的注释文件和它的位置]
annotationFile<-system.file('extdata','HG-U133_Plus_2_annot_part.csv',package='annotationTools')

##load annotation file[＃加载注释文件]
annotation&lt;-read.csv(annotationFile,colClasses='character',comment.char='#')[）]

##get gene symbols[＃基因符号。]
myPS<-c('117_at','1007_s_at','1552288_at',NA,'xyz_at')
getGENESYMBOL(myPS,annotation)

##track origin of annotation failure for the 3 last probe set IDs[＃注释失败的起源跟踪的最后3探针集ID]
getGENESYMBOL(myPS,annotation,diagnose=TRUE)

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


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