R语言 flowQ包 qaProcess.marginevents()函数中文帮助文档(中英文对照)

loveR

qaProcess.marginevents(flowQ)
qaProcess.marginevents()所属R语言包：flowQ

                                         Create QA process of type 'marginevents'
                                         创建类型marginevents“QA流程

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

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

This function takes a flowSet as input and  creates all necessary output for a 'marginevents' type QA process. Objects created by this function can be laid out as HTML using writeQAReport.
这个函数需要作为输入flowSet，并创建了所有必要的输出为“marginevents类型的QA流程。由这个函数创建的对象可以作为HTML使用writeQAReport奠定了。


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



qaProcess.marginevents(set, channels=NULL,side ="both", grouping=NULL,
    outdir, cFactor=2, absolute.value=NULL, name="margin events",
    sum.dimensions=NULL, det.dimensions=c(3,1), pdf=TRUE, ...)




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

参数：set
A flowSet.
AflowSet。


参数：channels
A character vector of channel names for which margin events are to be recorded. Will use all available channels except for the time channel if NULL.  
保证金事件记录的通道名称的一个特征向量。除外，如果NULL时间通道将使用所有可用的频道。


参数：side
Object of class "character". The margin on which to evaluate the filter. Either upper for the upper margin or lower for the lower margin or both for both margins.  
对象类"character"。评估过滤器的保证金。要么upper上缘或lower较低的保证金或both都利润率。


参数：grouping
A character vector defining one of the variables in the phenoData of set used as a grouping variable. If this argument is used and if absolute.value is NULL, outlier detection will be performed within groups rather than across all samples.
一个特征向量定义的变量之一phenoData set作为分组变量。如果这个参数是用来和如果absolute.value是NULL，离群点检测将在组内进行，而不是在所有样品。


参数：outdir
The directory to which the graphical output is to be saved. If multiple QA processes are to be combined, make sure to use the same directory for all of them.
图形输出要保存的目录。如果要合并的多个QA流程，确保所有使用同一目录。


参数：cFactor
The outlier threshold at which the QA criterion is considered to have failed. This is essentially the factor of standard deviations away from the average number of cells per sample for the respective channel.
离群值的阈值，在质量保证标准被认为已经失败。这实质上是在远离各自的通道，每个样品的单元平均数的标准偏差的因素。


参数：absolute.value
An absolute percentage of margin events below which the QA criterion is considered to be failed. If this argument is not NULL, cFactor is ignored.
绝对比例的保证金低于质量保证标准被认为是失败的事件。如果这种说法是非NULL，cFactor被忽略。


参数：name
The name of the process used for the headings in the HTML output.
该进程的名称用于在HTML输出的标题。


参数：sum.dimensions
The dimensions of summary plot generated in inches, default is NULL where the dimensions are automatically selected
总结图产生英寸的尺寸，默认值为NULL的尺寸自动选择


参数：det.dimensions
the dimensions of each sub image generated by the QA process in inches.  
英寸的QA过程中产生的每个子图像的尺寸。


参数：pdf
Logical indicating whether to create vectorized versions of images for this quality process. This should be set to FALSE if disk space is critical, since the pdf versions of the image consume much more space on the hard drive compared to the bitmap version. Setting the argument to FALSE will also speed up the process.
逻辑说明是否要建立这种质量的过程量化的图像版本。这应设置为FALSE如果磁盘空间是至关重要的，因为图像的PDF版本点阵图版本相比硬盘驱动器上消耗更多的空间。设置参数FALSE还将加快这一进程。


参数：...
Further arguments.
进一步的论据。


Details

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

QA processes of type 'marginevents' record the number of events that fall on the margins of the measurement range for each channel. Unproportionally high numbers of such events can indicate problems with the instrument settings or with compensation. These are either determined dynamically as outliers from the typical distribution of margin event percentages for the whole set, or, if absolute.value is not NULL, by an absolute cutoff value. If there is a natural grouping among the samples, this can be specified using the grouping argument. In this case, the outlier detection will be performed within its respective group for a particular sample.
QA流程类型marginevents“记录的事件，每个通道的测量范围的利润率下降的数量。仪器设置或补偿的此类事件unproportionally高的数字可以说明问题。这些是动态确定离群的一整套从典型的保证金事件的百分比分布，或absolute.value如果非NULL，绝对临界值。如果有一个样品间的自然分组，这可以使用grouping参数指定。在这种情况下，异常检测将执行其各自组内的一个特定样本。

For more details on how to layout qaProcess objects to  HTML, see writeQAReport and qaReport.
对于如何布局qaProcess对象为HTML的更多细节，请参阅writeQAReport和qaReport。


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

An object of class qaProcess.
对象类qaProcess。


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


Florian Hahne



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

writeQAReport, qaReport, qaProcess, qaProcess.timeline, qaProcess.timeflow, qaProcess.cellnumber
writeQAReport，qaReport，qaProcess，qaProcess.timeline，qaProcess.timeflow，qaProcess.cellnumber


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


## Not run: [＃无法运行：]
data(GvHD)
dest <- tempdir()
qp <- qaProcess.marginevents(GvHD, channels=c("FSC-H", "SSC-H"),
  outdir=dest)
qp

## End(Not run)[＃结束（不运行）]


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


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