data_rm_regions: Remove Region from an IFC_data Object

In IFC: Tools for Imaging Flow Cytometry

Remove Region from an IFC_data Object

Description

Removes regions from an already existing 'IFC_data' object.

Usage

data_rm_regions(obj, regions, list_only = TRUE, adjust_graph = TRUE, ...)

Arguments

obj	an 'IFC_data' object extracted by ExtractFromDAF(extract_features = TRUE) or ExtractFromXIF(extract_features = TRUE).
regions	a character vector of regions names to remove within 'obj'.
list_only	whether to return a list of elements that will be impacted by the removal. Default is TRUE. If FALSE then modified object will be returned.
adjust_graph	whether to try to adjust graph(s) when possible. Default is TRUE. -TRUE, graph(s) will be kept if possible using only regions, pops it depends that can be found in 'obj', -FALSE, graph(s) will be kept only if all features, regions, pops it refers to are found in 'obj', -NA, graph(s) will be removed no matter if features, regions, pops it refers to are found in 'obj'.
...	Other arguments to be passed.

Value

an ‘IFC_data' object or a list of elements impacted by removal depending on ’list_only' parameter.

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