gs_pop_get_stats_tfilter: Extract stats from populations(or nodes) within a restricted...

View source: R/getStats.R

gs_pop_get_stats_tfilterR Documentation

Extract stats from populations(or nodes) within a restricted time window

Description

Extract stats from populations(or nodes) within a restricted time window

Usage

gs_pop_get_stats_tfilter(x, ...)

gh_pop_get_stats_tfilter(
  x,
  nodes = NULL,
  type = c("Count", "Frequency"),
  inverse.transform = FALSE,
  stats.fun.arg = list(),
  tfilter = NULL,
  path = c("full", "auto"),
  ...
)

Arguments

x

GatingSet or GatingHierarchy

nodes

the character vector specifies the populations of interest. default is all available nodes

type

the character vector specifies the type of pop stats or a function used to compute population stats. When it is a character, it is expected to be either "Count" or "Frequency". Default is "Count" (total number of events in the populations). When it is a function, it takes a flowFrame object through the 'fr' argument and returns the stats as a named vector.

inverse.transform

logical flag . Whether to inverse transform the data before computing the stats.

stats.fun.arg

a list of arguments passed to ‘type' when ’type' is a function.

tfilter

Either a list (tmin, tmax) specifying the minimum and maximum of a the time window filter or a GatingHierarchy, whose minimum and maximum time will be used to determine the window. For both x and the reference GatingHierarchy in tfilter, the only channels that will match this filter are "Time" or "time" and the filter will be applied to each event such that only events with time value t where tmin <= t <= tmax will be evaluated.

path, ...

arguments passed to 'gh_get_pop_paths()'


RGLab/flowWorkspace documentation built on March 17, 2024, 2:24 p.m.