# Data Source Agnostic Filtering Tools

## Documentation for package ‘cohortBuilder’ version 1.0.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A B C D F G H L M P R S T U misc

cohortBuilder-package | Create data source cohort

## -- A --

add_filter | Add filter definition
add_filter.Cohort | Add filter definition
add_filter.Source | Add filter definition
add_hook | Cohort hooks.
add_source | Add source to Cohort object.
add_step | Add filtering step definition
add_step.Cohort | Add filtering step definition
add_step.Source | Add filtering step definition
as.tblist | Create in memory tables connection
attrition | Show attrition plot.
autofilter | Generate filters definition based on the Source data
autofilter.default | Generate filters definition based on the Source data
autofilter.tblist | Generate filters definition based on the Source data

## -- B --

binding-keys | Describe data relations with binding keys
bind_key | Describe data relations with binding keys
bind_keys | Describe data relations with binding keys

## -- C --

CbFilter | Base class for all cohortBuilder filters
CbFilterDateRange | Date range filter class
CbFilterDatetimeRange | Datetime range filter class
CbFilterDiscrete | Discrete filter class
CbFilterDiscreteText | Discrete text filter class
CbFilterMultiDiscrete | Multi-discrete filter class
CbFilterQuery | Query filter class
CbFilterRange | Range filter class
cb_domain_from_data | Extract domain from data
cb_domain_from_stats | Extract domain from stored filter statistics
cb_filter_data | Apply filter to data object
cb_filter_to_expr | Generate reproducible code expression for filter
cb_get_filter_data | Get filter-related data
cb_get_filter_defaults | Get filter default values
cb_get_filter_stats | Get filter statistics
cb_intersect_domain | Get effective filter value after domain intersection
cb_intersect_domain_values | Intersect two domain values for a filter type
cb_plot_filter_data | Plot filter data
cb_register_tool | Register cohortBuilder tools with an ellmer chat
cb_register_tools | Register cohortBuilder tools with an ellmer chat
cb_tool | Create a cohortBuilder tool definition
cb_tool_add_filters | Create a tool for adding filters to a cohort
cb_tool_apply_filters | Create a tool that adds filters and sets their values in one call
cb_tool_clear_filters | Create a tool for resetting filters to defaults
cb_tool_describe_state | Create a tool returning the current cohort state
cb_tool_filters_meta | Create a tool returning available filters metadata
cb_tool_get_code | Create a tool returning reproducible filtering code
cb_tool_get_data_summary | Create a tool returning row counts per dataset and step
cb_tool_remove_filters | Create a tool for removing filters from the cohort
cb_tool_remove_step | Create a tool for removing the last step
cb_tool_run | Create a tool for running the cohort pipeline
cb_tool_set_filter_values | Create a tool for setting filter values
cb_tool_toggle_filters | Create a tool for activating or deactivating filters
code | Return reproducible data filtering code.
Cohort | R6 class representing Cohort object.
cohort | Create new 'Cohort' object
cohort-methods | Cohort related methods
create-cohort | Create new 'Cohort' object

## -- D --

data_key | Define Source dataset key
describe | Create a description object
description | Show source data or filter description

## -- F --

filter | Define Cohort filter
filter_domain | Get a filter's domain
filter_effective_value | Get a filter's effective value
filter_variables | Get the variables a filter operates on

## -- G --

get_data | Get step related data
get_filter_params | Get filter parameters as a list
get_hook | Cohort hooks.
get_state | Get Cohort configuration state.

## -- H --

hooks | Cohort hooks.

## -- L --

librarian | Sample of library database

## -- M --

managing-cohort | Managing the Cohort object
managing-source | Managing the Source object

## -- P --

plot_data | Plot filter related Cohort data.
primary_keys | Define Source datasets primary keys
print.cb_tool | Create a cohortBuilder tool definition

## -- R --

register_filter_type | Register a custom filter type
restore | Restore Cohort object.
rm_filter | Remove filter definition
rm_filter.Cohort | Remove filter definition
rm_filter.Source | Remove filter definition
rm_step | Remove filtering step definition
rm_step.Cohort | Remove filtering step definition
rm_step.Source | Remove filtering step definition
run | Trigger data calculations.

## -- S --

set_source | Create Cohort source
set_source.tblist | Create Cohort source
shape | Describe the structure of a source
shape.default | Describe the structure of a source
shape.tblist | Describe the structure of a source
Source | R6 class representing a data source
source-layer | Source compatibility methods.
stat | Get Cohort related statistics.
step | Create filtering step
sum_up | Sum up Cohort state.

## -- T --

tblist | Create in memory tables connection
tblist_class | S7 class wrapper for the 'tblist' source

## -- U --

update_filter | Update filter definition
update_filter.Cohort | Update filter definition
update_filter.Source | Update filter definition
update_source | Update source in Cohort object.

## -- misc --

%->% | Operator simplifying adding steps or filters to Cohort and Source objects
.collect_data | Source compatibility methods.
.collect_data.default | Source compatibility methods.
.collect_data.tblist | Source compatibility methods.
.gen_id | Generate random ID
.get_attrition_count | Source compatibility methods.
.get_attrition_count.default | Source compatibility methods.
.get_attrition_label | Source compatibility methods.
.get_attrition_label.default | Source compatibility methods.
.get_item | Return list of objects matching provided condition.
.get_method | Get function definition
.get_stats | Source compatibility methods.
.get_stats.default | Source compatibility methods.
.get_stats.tblist | Source compatibility methods.
.if_value | Return default value if values are equal
.init_step | Source compatibility methods.
.init_step.default | Source compatibility methods.
.init_step.tblist | Source compatibility methods.
.post_binding | Source compatibility methods.
.post_binding.default | Source compatibility methods.
.post_filtering | Source compatibility methods.
.post_filtering.default | Source compatibility methods.
.pre_filtering | Source compatibility methods.
.pre_filtering.default | Source compatibility methods.
.print_filter | Method for printing filter details
.print_filter.default | Method for printing filter details
.propagate_domains | Propagate domains between steps
.propagate_domains.default | Propagate domains between steps
.propagate_domains.tblist | Propagate domains between steps
.repro_code_tweak | Source compatibility methods.
.run_binding | Source compatibility methods.
.run_binding.default | Source compatibility methods.