polyFilterApply: Apply polygonal filters to cdata

In gerbeldo/tidycell: CellID Data Analysis Inside the Tidyverse

Apply polygonal filters to cdata

Description

Apply polygonal filters to cdata

Usage

polyFilterApply(
  polygon_df_list,
  cdata,
  truthMode = "all",
  cell_unique_id_field = "ucid"
)

Arguments

polygon_df_list	A list of polygon dataframes with columns: x (values) y (values) xvar (variable name for x values) yvar (variable name for y values) type ("Subtractive" or "Additive")
cdata	A "cdata" dataframe.
truthMode	Logical priority for "Subtractive" and "Additive" polygon filter types, passed to calculateTruth. Should be one of "all" (Subtractive overcomes Additive) or "any" (Additive overcomes Subtractive).
cell_unique_id_field	Name for the column holding the unique identifier (a "primary key") for each data point (i.e. the "ucid" is not suficcient for time series datasets).

Value

a "saved_data" list object, where the cdata is appended a "filter" logical column.

gerbeldo/tidycell documentation built on Aug. 15, 2022, 2:35 p.m.