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

loveR

getAnnMap(annotate)
getAnnMap()所属R语言包：annotate

                                        Get annotation map
                                         获取标注图

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

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

This function retrieves a map object from an annotation data package.  It is intended to serve as a common interface for obtaining map objects from both SQLite-based and environment-based annotation data packages.
此函数检索注释数据包从一个图对象。它的目的是作为一个获得SQLite的基础和环境为基础的注释数据包映射对象的共同接口。


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


getAnnMap(map, chip, load = TRUE, type = c("db", "env"))



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

参数：map
a string specifying the name of the map to retrieve.  For example, "ENTREZID" or "GO"
一个字符串，指定图检索的名称。例如，"ENTREZID"或"GO"


参数：chip
a string describing the chip or genome
一个字符串描述的芯片或基因组


参数：load
a logical value.  When TRUE, getAnnMap will try to load the annotation data package if it is not already attached.
一个逻辑值。当TRUE，getAnnMap将尝试加载标注的数据包，如果它尚未被重视。


参数：type
a character vector of one or more annotation data package types.  The currently supported types are "db" and "env".  If load is TRUE, you can specify both "db" and "env" and the order will determine which type is tried first.  This provides a fall-back mechanism when the preferred annotation data package type is not available.  If type is missing, then the first matching annotation package found in the search path will be used, and then the default value of type takes over.
特征向量的一个或多个注释的数据包类型。目前支持的类型"db"和"env"。如果load是TRUE，您可以指定两个"db"和"env"“的顺序将决定先尝试哪一种类型。这提供了一种后备机制是不可用时首选的注释数据包类型。如果type丢失，然后在搜索路径中找到第一个匹配的注解包将被使用，并然后type的默认值接管。


Details

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

getAnnMap uses the search path (see search) to find an appropriate annotation data package; when called with chip="hgu95av2", the function will use the first hgu95av2 package on the search path whether it be db or environment-based.  If load=TRUE and no suitable package is found on the search path, then the function will attempt to load an appropriate package.  The type argument is used to determine which type of package (db or env) is loaded first.
getAnnMap使用的搜索路径（见search）找到一个合适的注解数据包;chip="hgu95av2"，功能使用上的搜索路径第一hgu95av2包，无论是DB调用时或环境为基础。如果load=TRUE搜索路径上发现没有合适的包，那么该函数将试图加载一个合适的包。 type参数是用来确定哪种类型的包（DB或env）首先加载。


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

If type is "db", an S4 object representing the requested map.  If type is "env", an R environment object representing the requested map.
如果type是"db"，S4对象的代表要求的图。如果type是"env"，一个Renvironment对象代表请求的图。


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


Seth Falcon



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


map <- getAnnMap("ENTREZID", "hgu95av2", load=TRUE, type=c("env", "db"))
class(map)

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


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