R语言 flowCore包 read.flowSet()函数中文帮助文档(中英文对照)

loveR

read.flowSet(flowCore)
read.flowSet()所属R语言包：flowCore

                                        Read a set of FCS files
                                         读了FCS的文件集

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

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

Read one or several FCS files: Data File Standard for Flow
阅读：一个或几个FCS的文件流数据文件标准


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



read.flowSet(files=NULL, path=".",pattern=NULL, phenoData,
             descriptions,name.keyword,alter.names=FALSE,
             transformation = "linearize", which.lines=NULL,
             column.pattern = NULL, decades=0,sep="\t",
             as.is=TRUE, name, ncdf=FALSE, dataset=NULL, ...)




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

参数：files
Optional character vector with filenames.
可选的特征向量与文件名。


参数：path
Directory where to look for the files.
目录中寻找文件。


参数：pattern
This argument is passed on to dir, see details.  
这种说法被传递dir，看到的细节。


参数：phenoData
An object of class AnnotatedDataFrame, character or a list of values to be extracted from the flowFrame object, see details.
一个类的对象AnnotatedDataFrame，character或flowFrame对象中提取值的列表，查看详细信息。


参数：descriptions
Character vector to annotate the object of class flowSet.
特征向量注释类flowSet的对象。


参数：name.keyword
An optional character vector that specifies which FCS keyword to use as the sample names. If this is not set, the GUID of the FCS file is used for sampleNames, and if that is not present (or not unique), then the file names are used.  
一个可选的特征向量，指定使用FCS的关键字作为样本名。如果不这样设置，使用的FCS文件的GUID为sampleNames，如果不存在（或不是唯一的），然后使用文件名。


参数：alter.names
see read.FCS for details.
看到read.FCS详情。


参数：transformation
see read.FCS for details.
看到read.FCS详情。


参数：which.lines
see read.FCS for details.
看到read.FCS详情。


参数：column.pattern
see read.FCS for details.
看到read.FCS详情。


参数：decades
see read.FCS for details.
看到read.FCS详情。


参数：sep
Separator character that gets passed on to read.AnnotatedDataFrame.
分隔符，被传递到read.AnnotatedDataFrame。


参数：as.is
Logical that gets passed on to read.AnnotatedDataFrame. This controls the automatic coercion of characters to factors in the phenoDataslot.  
逻辑传递到read.AnnotatedDataFrame。这控制自动强制字符phenoData插槽因素的。


参数：name
An optional character scalar used as name of the object.
作为一个可选字符标对象的名称。


参数：ncdf
Instead of reading all data into memory, this switches to file-based data storage. See read.FCS for details.  
而不是所有的数据读入内存，切换到基于文件的数据存储。看到read.FCS详情。


参数：dataset
see read.FCS for details.
看到read.FCS详情。


参数：...
Further arguments that get passed on to read.AnnotatedDataFrame, see details.
进一步的参数被传递到read.AnnotatedDataFrame，看到的细节。


Details

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

There are four different ways to specify the file from which data is to be imported:
有四种不同的方式来指定从其中的数据要导入的文件：

First, if the argument phenoData is present and is of class AnnotatedDataFrame, then the file names are obtained from its sample names (i.e. column name. The column is mandatory, and an error will be generated if it is not there.  Alternatively, the argument phenoData can be of class character, in which case this function tries to read a AnnotatedDataFrame object from the file with that name by calling read.AnnotatedDataFrame(file.path(path,phenoData),...).  
首先，如果参数phenoData是目前类AnnotatedDataFrame，然后在文件名得到其样品名称（即列name。列是强制性的，会发生错误产生的，如果它不存在。另外，参数phenoData类character，在这种情况下，这个函数试图从文件中读取这个名字AnnotatedDataFrame对象通过调用read.AnnotatedDataFrame(file.path(path,phenoData),...)。

In some cases the file names are not a reasonable selection criterion and the user might want to import files based on some keywords within the file. One or several keyword value pairs can be given as the phenoData argument in form of a named list.
在某些情况下，文件名是不是一个合理的选择标准，用户可能要导入的文件根据文件中的一些关键字。一个或几个关键字值对，可以在一个名为列表的形式给出作为phenoData参数。

Third, if the argument phenoData is not present and the argument files is not NULL, then files is expected to be a character vector with the file names.
第三，如果参数phenoData是不存在的说法files非NULL，则files预计将与文件名的特征向量。

Fourth, if neither the argument phenoData is present nor files is not NULL, then the file names are obtained by calling   dir(path, pattern).
第四，如果既没有参数phenoData现在也不files非NULL，然后文件名调用dir(path, pattern)获得。


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

An object of class flowSet.
对象类flowSet。


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


F. Hahne, N.Le Meur, B. Ellis



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



fcs.loc <- system.file("extdata",package="flowCore")
file.location <- paste(fcs.loc, dir(fcs.loc), sep="/")

samp <- read.flowSet(file.location[1:3])


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


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