flowCore (version 1.38.2)

filterResultList-class: Class "filterResultList"

Description

Container to store the result of applying a filter on a flowSet object

Objects from the Class

Objects are created by applying a filter on a flowSet. The user doesn't have to deal with manual object instantiation.

Slots

.Data:

Object of class "list". The class directly extends list, and this slot holds the list data.

frameId:

Object of class "character" The IDs of the flowFrames in the filtered flowSet.

filterDetails:

Object of class "list". Since filterResultList inherits from filterResult, this slot has to be set. It contains only the input filter.

filterId:

Object of class "character". The identifier for the object.

Extends

Class "list", from data part. Class "filterResult", directly. Class "concreteFilter", by class "filterResult", distance 2. Class "filter", by class "filterResult", distance 3.

Methods

[

signature(x = "filterResultList", i = "ANY"): Subset to filterResultList.

[[

signature(x = "filterResultList", i = "ANY"): Subset to individual filterResult.

names

signature(x = "filterResultList"): Accessor to the frameId slot.

parameters

signature(object = "filterResultList"): Return parameters on which data has been filtered.

show

signature(object = "filterResultList"): Print details about the object.

split

signature(x = "flowSet", f = "filterResultList"): Split a flowSet based on the results in the filterResultlIst. See split for details.

summary

signature(object = "filterResultList"): Summarize the filtering operation. This creates a filterSummaryList object.

See Also

filter, filterResult, logicalFilterResult, multipleFilterResult, randomFilterResult

Examples

## Not run: 
# 
# library(flowStats)
# ## Loading example data and creating a curv1Filter
# data(GvHD)
# dat <- GvHD[1:3]
# c1f <- curv1Filter(filterId="myCurv1Filter", x=list("FSC-H"), bwFac=2)
# 
# ## applying the filter
# fres <- filter(dat, c1f)
# fres
# 
# ## subsetting the list
# fres[[1]]
# fres[1:2]
# 
# ## details about the object
# parameters(fres)
# names(fres)
# summary(fres)
# 
# ## splitting based on the filterResults
# split(dat, fres)
#  ## End(Not run)