Skip to contents

All functions

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
Cohort
R6 class representing Cohort object.
Source
R6 class representing a data source
add_filter()
Add filter definition
add_source()
Add source to Cohort object.
add_step()
Add filtering step definition
attrition()
Show attrition plot.
autofilter()
Generate filters definition based on the Source data
bind_keys() bind_key()
Describe data relations with binding keys
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() cb_register_tools()
Register cohortBuilder tools with an ellmer chat
cb_tool() print(<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-methods
Cohort related methods
cohortBuilder-package
Create data source cohort
cohort()
Create new 'Cohort' object
data_key()
Define Source dataset key
describe()
Create a description object
description()
Show source data or filter description
.gen_id()
Generate random ID
.get_item()
Return list of objects matching provided condition.
.get_method()
Get function definition
.if_value()
Return default value if values are equal
.print_filter()
Method for printing filter details
.propagate_domains()
Propagate domains between steps
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
get_data()
Get step related data
get_filter_params()
Get filter parameters as a list
get_state()
Get Cohort configuration state.
`%->%`
Operator simplifying adding steps or filters to Cohort and Source objects
add_hook() get_hook()
Cohort hooks.
librarian
Sample of library database
managing-cohort
Managing the Cohort object
managing-source
Managing the Source object
plot_data()
Plot filter related Cohort data.
primary_keys()
Define Source datasets primary keys
register_filter_type()
Register a custom filter type
restore()
Restore Cohort object.
rm_filter()
Remove filter definition
rm_step()
Remove filtering step definition
run()
Trigger data calculations.
set_source()
Create Cohort source
shape()
Describe the structure of a source
.init_step() .collect_data() .get_stats() .pre_filtering() .post_filtering() .post_binding() .repro_code_tweak() .get_attrition_label() .get_attrition_count() .run_binding()
Source compatibility methods.
stat()
Get Cohort related statistics.
step()
Create filtering step
sum_up()
Sum up Cohort state.
tblist() as.tblist()
Create in memory tables connection
tblist_class
S7 class wrapper for the `tblist` source
update_filter()
Update filter definition
update_source()
Update source in Cohort object.