rm_filter: Remove filter definition

In cohortBuilder: Data Source Agnostic Filtering Tools

Remove filter definition

Description

Remove filter definition

Usage

rm_filter(x, step_id, filter_id, ...)

## S3 method for class 'Cohort'
rm_filter(
  x,
  step_id,
  filter_id,
  run_flow = FALSE,
  hook = list(pre = get_hook("pre_rm_filter_hook"), post =
    get_hook("post_rm_filter_hook")),
  ...
)

## S3 method for class 'Source'
rm_filter(x, step_id, filter_id, ...)

Arguments

x	An object from which filter should be removed.
step_id	Id of the step from which filter should be removed.
filter_id	Id of the filter to be removed.
...	Other parameters passed to specific S3 method.
run_flow	If 'TRUE', data flow is run after the filter is removed.
hook	List of hooks describing methods to run before/after the filter is removed. See hooks for more details.

Value

Method dependent object (i.e. 'Cohort' or 'Source') having selected filter removed.

See Also

managing-cohort, managing-source

cohortBuilder documentation built on July 3, 2026, 9:07 a.m.