Function reference • cohortBuilder

All functions

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.

bind_keys() bind_key(): Describe data relations with binding keys

code(): Return reproducible data filtering code.

cohort-methods: Cohort related methods

cohortBuilder-package: Create data source cohort

cohort(): Create new 'Cohort' object

def_filter() new_filter(): Define custom filter.

data_key(): Define Source dataset key

description(): Show source data or filter description

.as_constructor(): Attach proper class to filter constructor

.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

cb_filter.discrete() cb_filter.discrete_text() cb_filter.range() cb_filter.date_range() cb_filter.multi_discrete() cb_filter.query(): Filter Source types methods

filter(<discrete>) filter(<discrete_text>) filter(<range>) filter(<date_range>) filter(<multi_discrete>) filter(<query>): Filter types

filter(): Define Cohort filter

get_data(): Get step related data

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

restore(): Restore Cohort object.

rm_filter(): Remove filter definition

rm_step(): Remove filtering step definition

run(): Trigger data calculations.

set_source(): Create Cohort 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

update_filter(): Update filter definition

update_source(): Update source in Cohort object.