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

loveR

getChipInfo(lumi)
getChipInfo()所属R语言包：lumi

                                        Get Illumina Chip Information based on probe identifiers
                                         Illumina的芯片信息的基础上探针标识符

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

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

Retrieve the matched Illumina chip information by searching the provided probe identifiers through the Illumina identifiers in all manifest files.
Illumina公司通过在manifest文件标识符提供探针标识符的搜索，检索匹配的Illumina的芯片信息。


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


getChipInfo(x, lib.mapping = NULL, species = c("Human", "Mouse", "Rat", "Unknown"), chipVersion = NULL, idMapping = FALSE, returnAllMatches = FALSE, verbose = TRUE)



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

参数：x
a vector of probe identifiers, ExpressionSet object or a matrix with probe identifiers as row names  
一个探针标识的的向量，ExpressionSet对象或一个矩阵探针行名称标识符


参数：lib.mapping
the ID mapping library. If it is provided, the parameter "species" will be ignored.  
ID映射库。如果它提供的参数将被忽略“物种”。


参数：species
species of the chip designed for. If users do not know it, it can be set as "Unknown".  
种设计的芯片。如果用户不知道它，它可以设置为“未知”。


参数：chipVersion
chipVersion information returned by function getChipInfo  
函数getChipInfo chipVersion返回的信息


参数：idMapping
determine whether return the idMapping information (between Illumina ID and nuID)  
确定是否返回idMapping的的信息（Illumina的编号和nuID）


参数：returnAllMatches
determine whether return all matches or just the best match  
确定是否返回所有匹配或只是最佳匹配


参数：verbose
determine whether print some warning information  
确定是否打印一些警告信息


Details

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

The function searches the provided probe Identifiers (Illumina IDs or nuIDs) through all the manifest file ID information kept in the IDMapping libraries (lumiHumanIDMapping, lumiMouseIDMapping, lumiRatIDMapping). The Illumina IDs kept in the library include "Search\_key" ("Search\_Key"), "Target" ("ILMN\_Gene"), "Accession", "Symbol", "ProbeId" ("Probe\_Id"). To determine the best match, the function calculate the number of matched probes. The higher "matchedProbeNumber" is claimed as better. When the "matchedProbeNumber" is the same, the manifest file with fewer probes is claimed as better. If x is NULL and chipVersion is provided, it will return the entire mapping table of the chip.
功能搜索所有的manifest文件ID保存在IDMapping库信息（lumiHumanIDMapping，lumiMouseIDMapping，lumiRatIDMapping）所提供的探针标识符（Illumina的ID或nuIDs的）。 Illumina的库中保存的ID，包括“搜索\ _key”（“搜索\ _key”的），“目标”（“ILMN \ _Gene”），“入世”，“符号”，“ProbeId” （“探针\ _id”）。 ，以确定最佳匹配，功能匹配的探针数量计算。为更好地声称更高“matchedProbeNumber”。当“matchedProbeNumber”是一样的，用更少的探针的manifest文件是为更好地声称。如果x是NULL，提供chipVersion，它会返回整个芯片的映射表。


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

The function returns a list with following items:
该函数返回下列项目列表：


参数：chipVersion
the file name of the manifest file for the corresponding version and release
相应的版本和发行的manifest文件的文件名


参数：species
the species of the chip designed for
设计的芯片的种类


参数：IDType
the type of probe identifier
探针标识的类型


参数：chipProbeNumber
the number of probes in the manifest file
在manifest文件中的探针数量


参数：matchedProbeNumber
the number of input probes matching the manifest file
匹配列表文件的输入探针


参数：idMapping
id mapping information between Illumina ID and nuID
Illumina的编号和nuID ID之间的映射信息

When parameter "returnAllMatches" is TRUE, the items of "chipVersion", "IDType", "chipProbeNumber", "inputProbeNumber", "matchedProbeNumber" will be a vector corresponding to the matched manifest files, whose "matchedProbeNumber" is larger than zero, and the "idMapping" will be a matrix with each column corresponding to one matched manifest file. All of the items are sorted from the best match to worst (The higher "matchedProbeNumber" is claimed as better. When the "matchedProbeNumber" is the same, the manifest file with fewer probes is claimed as better.).
当参数“returnAllMatches”为TRUE，的“chipVersion”，“IDType”，“chipProbeNumber”，“inputProbeNumber”，“matchedProbeNumber”的项目将是一个向量对应匹配的manifest文件，其“ matchedProbeNumber“是大于零，”idMapping“将是一个矩阵，每一列对应一个匹配的manifest文件。的所有项目都是从最好到最差的比赛排序（越高“matchedProbeNumber”声称为更好的。，当“matchedProbeNumber”是相同的，用更少的探针的manifest文件是为更好地声称）。


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


Pan Du



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

nuID2IlluminaID, IlluminaID2nuID
nuID2IlluminaID，IlluminaID2nuID


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


        ## load example data[＃加载数据为例]
        data(example.lumi)
        if (require(lumiHumanIDMapping)) {
                chipInfo <- getChipInfo(example.lumi, species='Human')
                chipInfo
        }

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


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