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

loveR

readCdfUnits(affxparser)
readCdfUnits()所属R语言包：affxparser

                                        Reads units (probesets) from an Affymetrix CDF file
                                         从Affymetrix公司CDF文件中读取的单位（probesets）

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

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

Reads units (probesets) from an Affymetrix CDF file. Gets all or a subset of units (probesets).
读取单位（probesets）从Affymetrix公司CDF文件。获取全部或一个单位的一个子集（probesets）。


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


readCdfUnits(filename, units=NULL, readXY=TRUE, readBases=TRUE, readExpos=TRUE, readType=TRUE, readDirection=TRUE, stratifyBy=c("nothing", "pmmm", "pm", "mm"), readIndices=FALSE, verbose=0)



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

参数：filename
The filename of the CDF file.
CDF文件的文件名。


参数：units
An integer vector of unit indices specifying which units to be read.  If NULL, all units are read.
integervector单位指标指定要读取哪个单位。如果NULL，读取各单位。


参数：readXY
If TRUE, cell row and column (x,y) coordinates are retrieved, otherwise not.
如果TRUE，单元格的行和列（X，Y）坐标检索，否则不。


参数：readBases
If TRUE, cell P and T bases are retrieved, otherwise not.
如果TRUE，单元P和T碱基检索，否则不。


参数：readExpos
If TRUE, cell "expos" values are retrieved, otherwise not.
如果TRUE“单元”博览会“检索值，否则不。


参数：readType
If TRUE, unit types are retrieved, otherwise not.
如果TRUE检索，单位类型，否则不。


参数：readDirection
If TRUE, unit and group directions are retrieved, otherwise not.
如果TRUE，单位和团体的方向，否则不检索。


参数：stratifyBy
A character string specifying which and how elements in group fields are returned. If "nothing", elements are returned as is, i.e. as vectors. If "pm"/"mm", only elements corresponding to perfect-match (PM) / mismatch (MM) probes are returned (as vectors). If "pmmm", elements are returned as a matrix where the first row holds elements corresponding to PM probes and the second corresponding to MM probes.  Note that in this case, it is assumed that there are equal number of PMs and MMs; if not, an error is generated. Moreover, the PMs and MMs may not even be paired, i.e. there is no guarantee that the two elements in a column corresponds to a PM-MM pair.
一个character指定哪些组领域中的元素如何返回字符串。 "nothing"如果元素返回的是，即vector的。如果"pm"/"mm"，返回相应的完美匹配（PM）/错配（MM）探针的唯一元素（vector的）。如果"pmmm"，元素返回一个矩阵，其中第一行持有相应下午探针和第二mm探针相应的元素。请注意，在这种情况下，它被认为有同等数量的PMS和MMS;如果不是，则会产生一个错误。此外，PMS和MMS可能甚至不进行配对，即有两个元素，在一列对应一个下午的MM对不能保证。


参数：readIndices
If TRUE, cell indices calculated from the row and column (x,y) coordinates are retrieved, otherwise not. Note that these indices are one-based.
如果TRUE，由行和列计算单元指数（X，Y）坐标检索，否则不。请注意，这些指数是基于一个。


参数：verbose
An integer specifying the verbose level. If 0, the file is parsed quietly.  The higher numbers, the more details.
integer指定的详细级别。如果为0，该文件是悄悄地解析。较高的数字，更多的细节。


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

A named list where the names corresponds to the names of the units read.  Each element of the list is in turn a list structure with three components:
一个名为list名称对应单位的名称读。列表中的每个元素是反过来list结构由三个部分组成：


参数：groups
A list with one component for each group (also called block). The information on each group is a list of up to seven components: x, y, pbase, tbase, expos, indices, and direction. All fields but the latter have the same number of values as there are cells in the group.  The latter field has only one value indicating the direction for the whole group.  
一个list各组（也称为块）的一个组成部分。对每个组的信息是list高达七部分组成：x，y，pbase，tbase，expos，indices，direction。有单元组中的各个领域，但后者有相同数目的值。后场只有一个值，该值指示为整个集团的方向。


参数：type
An integer specifying the type of the unit, where 1 is "expression", 2 is "genotyping", 3 is "CustomSeq", and 4 "tag".
integer指定类型的单位，其中1是“表达”，2“基因分型”，三是“CustomSeq”，“标签”。


参数：direction
An integer specifying the direction of the unit, which defines if the probes are interrogating the sense or the anti-sense target, where 0 is "no direction", 1 is "sense", and 2 is "anti-sense".
integer指定的单位，其定义，如果探针询问感或反义的目标，方向，其中0是“没有方向”，是“感觉”，2“反义“。


单元指数是一个基于----------Cell indices are one-based----------

Note that in affxparser all cell indices are by convention one-based, which is more convenient to work with in R.  For more details on one-based indices, see 2. Cell coordinates and cell indices.
请注意，在affxparser所有单元指数是由公约的一个基础，这是更方便地在R基于指数的更多细节，请参阅2. Cell coordinates and cell indices。


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



James Bullard, <a href="mailto:bullard@stat.berkeley.edu">bullard@stat.berkeley.edu</a> and Kasper
Daniel Hansen, <a href="mailto:khansen@stat.berkeley.edu">khansen@stat.berkeley.edu</a>.
Modified by Henrik Bengtsson (<a href="http://www.braju.com/R/">http://www.braju.com/R/</a>) to read
any subset of units and/or subset of parameters, to stratify by PM/MM,
and to return cell indices.d




参考文献----------References----------

June 14, 2005. http://www.affymetrix.com/support/developer/

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

readCdfCellIndices().
readCdfCellIndices（）。


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


##############################################################[＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃ ＃＃＃＃＃＃＃＃＃＃＃]
if (require("AffymetrixDataTestFiles")) {            # START #[开始＃]
##############################################################[＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃ ＃＃＃＃＃＃＃＃＃＃＃]

# Find any CDF file[发现任何CDF文件]
cdfFile <- findCdf()

# Read all units in a CDF file [~20s =&gt; 0.34ms/unit][各单位在CDF文件读[~20 => 0.34ms/unit]]
cdf0 <- readCdfUnits(cdfFile, readXY=FALSE, readExpos=FALSE)

# Read a subset of units in a CDF file [~6ms =&gt; 0.06ms/unit][在CDF文件阅读单位的一个子集[~6ms的> 0.06ms/unit]]
units1 <- c(5, 100:109, 34)
cdf1 <- readCdfUnits(cdfFile, units=units1, readXY=FALSE, readExpos=FALSE)
stopifnot(identical(cdf1, cdf0[units1]))
rm(cdf0)

# Create a unit name to index map[创建单位名称索引图]
names <- readCdfUnitNames(cdfFile)
units2 <- match(names(cdf1), names)
stopifnot(all.equal(units1, units2))
cdf2 <- readCdfUnits(cdfFile, units=units2, readXY=FALSE, readExpos=FALSE)

stopifnot(identical(cdf1, cdf2))

##############################################################[＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃ ＃＃＃＃＃＃＃＃＃＃＃]
}                                                     # STOP #[停止＃]
##############################################################[＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃ ＃＃＃＃＃＃＃＃＃＃＃]


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


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