applyGatingStrategy: Apply Gating Strategy

View source: R/applyGatingStrategy.R

applyGatingStrategyR Documentation

Apply Gating Strategy

Description

Applies Gating Strategy to an 'IFC_data' object

Usage

applyGatingStrategy(
  obj,
  gating,
  keep,
  display_progress = TRUE,
  verbose = FALSE,
  ...
)

Arguments

obj

an 'IFC_data' object extracted with features extracted.

gating

an 'IFC_gating' object extracted by readGatingStrategy.

keep

names of population(s) that should not be overwritten using 'gating'.

display_progress

whether to display a progress bar. Default is TRUE.

verbose

whether to display information (use for debugging purpose). Default is FALSE.

...

other arguments to be passed.

Details

/!\ Please note that all former gating strategy (i.e. regions, pops, graphs and stats) will be removed from returned object, with the exception of population(s) described in 'keep'.
An error will be thrown if a feature is required to create a population or a graph but can't be found in 'obj'.
When tagged population(s) is(are) imported, objects from this(these) population(s) outside 'obj' will be discarded.
If this results in NULL, then all objects will be tagged.

Value

A named list of class 'IFC_data' with new regions, pops and graphs


IFC documentation built on Sept. 14, 2023, 1:08 a.m.