R语言 flowCore包 boundaryFilter-class()函数中文帮助文档(中英文对照)

loveR

boundaryFilter-class(flowCore)
boundaryFilter-class()所属R语言包：flowCore

                                        Class "boundaryFilter"
                                         类“boundaryFilter”

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

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

Class and constructor for data-driven filter objects that discard margin events.
类和构造数据驱动的filter放弃保证金事件的对象。


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



boundaryFilter(x, tolerance=.Machine$double.eps, side=c("both", "lower",
"upper"), filterId="defaultBoundaryFilter")




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

参数：x
Character giving the name(s) of the measurement parameter(s) on which the filter is supposed to work. Note that all events on the margins of ay of the channels provided by x will be discarded, which is often not desired. Such events may not convey much information in the particular channel on which their value falls on the margin, however they may well be informative in other channels.  
给字符的过滤器应该工作的测量参数（S）的名称（S）。请注意，所有事件提供渠道xAY利润率将被丢弃，往往不理想。这样的事件可能不会传达很多信息，在特定的通道，其价值利润率下降，但它们很可能是其他渠道的信息中。


参数：tolerance
Numeric vector, used to set the tolerance slot of the object. Can be set separately for each element in x. R's recycling rules apply.  
数字向量，用于设置tolerance对象的槽。可以单独设置每个元素在x。 R的回收规则适用。


参数：side
Character vector, used to set the side slot of the object.  Can be set separately for each element in x. R's recycling rules apply.
特征向量，用于设置side对象的槽。可以单独设置每个元素在x。 R的回收规则适用。


参数：filterId
An optional parameter that sets the filterId slot of this filter. The object can later be identified by this name.  
一个可选参数，设置filterId此过滤器的插槽。对象可以在以后确定了这个名字。


Details

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

Flow cytomtery instruments usually operate on a given data range, and the limits of this range are stored as keywords in the FSC files. Depending on the amplification settings and the dynamic range of the measured signal, values can occur that are outside of the measurement range, and most instruments will simply pile those values at the minimum or maximum range limit. The boundaryFilter removes these values, either for a single parameter, or for a combination of parameters. Note that it is often desirable to treat boundary events on a per-parameter basis, since their values might be uninformative for one particular channel, but still be useful in all of the other channels.
流cytomtery工具通常运行在一个给定的数据范围，此范围的限制，金管会的文件中的关键字中。根据放大的设置和测量信号的动态范围，可发生值，测量的范围之外，大多数仪器将简单地堆放范围限制在最小或最大的值。 boundaryFilter删除这些值，无论是一个单一的参数，或参数的组合。请注意，它常常是可取的每个参数的基础上处理边界事件，因为他们的价值观可能是无意义的一个特定的通道，但仍然是所有其他渠道的有益。

The constructor boundaryFilter is a convenience function for object instantiation. Evaluating a boundaryFilter results in a single sub-populations, an hence in an object of class filterResult.
构造boundaryFilter是一个对象实例化的便利功能。评价一个boundaryFilter结果，在一个单一的亚人群的因此，在一个对象类filterResult。


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

Returns a boundaryFilter object for use in filtering flowFrames or other flow cytometry objects.
使用过滤boundaryFilters或其他流式单元仪检测对象返回一个flowFrame对象。


延伸----------Extends----------

Class "parameterFilter", directly.
类"parameterFilter"，直接。

Class "concreteFilter", by class parameterFilter, distance 2.
类"concreteFilter"类parameterFilter，距离2。

Class "filter", by class parameterFilter, distance 3.
类"filter"类parameterFilter，距离3。


插槽----------Slots----------




tolerance: Object of class "numeric". The machine tolerance used to decide whether an event is on the measurement boundary. Essentially, this is done by evaluating
tolerance类"numeric"的对象。机器公差用于决定事件是否是测量边界上。从本质上讲，这是通过评估




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
side类"character"的对象。评估过滤器的保证金。要么upper上缘或lower较低的保证金或both


类的对象----------Objects from the Class----------

Objects can be created by calls of the form new("boundaryFilter",     ...) or using the constructor boundaryFilter.  Using the constructor is the recommended way of object instantiation:
对象可以创建检测形式new("boundaryFilter",     ...)或使用的构造boundaryFilter。使用构造对象实例的推荐方式：


方法----------Methods----------




%in% signature(x = "flowFrame", table =         "boundaryFilter"): The workhorse used to evaluate the filter on data. This is usually not called directly by the user, but
在％signature(x = "flowFrame", table =         "boundaryFilter")：主力用来评估对数据的过滤器。这通常不是直接调用的用户，但




show signature(object = "boundaryFilter"): Print
显示signature(object = "boundaryFilter")：打印


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


Florian Hahne



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

flowFrame, flowSet, filter for evaluation of boundaryFilters and Subset for subsetting of flow cytometry data sets based on that.
flowFrame，flowSet，filter评价boundaryFilters和Subset子集，流式单元仪数据设置此基础上。


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




## Loading example data[＃载入数据为例]
dat <- read.FCS(system.file("extdata","0877408774.B08",
package="flowCore"))

## Create directly. Most likely from a command line[＃直接创建。最有可能从一个命令行]
boundaryFilter("FSC-H", filterId="myBoundaryFilter")

## To facilitate programmatic construction we also have the following[＃为了便于我们也有以下的纲领性建设]
bf <- boundaryFilter(filterId="myBoundaryFilter", x=c("FSC-H"))

## Filtering using boundaryFilter[＃过滤使用boundaryFilter]
fres <- filter(dat, bf)
fres
summary(fres)

## We can subset the data with the result from the filtering operation.[＃我们可以过滤操作的结果子集的数据。]
Subset(dat, fres)

## A boundaryFilter on the lower margins of several channels[＃boundaryFilter多种渠道的利润率较低]
bf2 <- boundaryFilter(x=c("FSC-H", "SSC-H"), side="lower")


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


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