flow_Prune: Prune Flow Data

Description Usage Arguments Value

Description

Function to remove columns or events that meet specific conditions from a flow data frame.

Usage

1
2
flow_Prune(flowObj, parameter, upperBound = NULL, lowerBound = NULL,
  fromTable = FALSE)

Arguments

flowObj

Data frame, flowFrame, or a list containing either class of object to be manipulated

parameter

String or vector of strings matching a column label or set of labels in the flow data frame. If a parameter argument is passed but no upper or lower bounds are specified, all designated parameters will be dropped from the flow data frame.

upperBound

(Optional) Numeric defining the allowed maximum value for a specific parameter (if designated by the parameter argument) or for any parameter (if no parameter argument provided). If a value falls outside this bound, the entire event (row) will be removed from the flow data frame.

lowerBound

See upperBound

fromTable

(Optional, dependent on calling get_Parameters() function) Logical indicating whether or not the function should look in the parameter table for upper/lower bound arguments. If true, ignores provided parameter, upperBound, and lowerBound arguments (all the logic is in the table). Default = FALSE

Value

A pruned flow object of the type initially passed to the function


ssmpsn2/flowAssist documentation built on May 30, 2019, 7:12 p.m.