Function reference

All functions and classes exported by ti.

Functions

Function	Description
`abc()`	ABC classification function
`abc_fn()`	Classify a group by proportion of a variable (A,B,C,…)
`atd()`	All period-to-date
`atd_fn()`	All-to-date execution function
`augment_standard_calendar()`	Add Comprehensive Date-Based Attributes to a DBI lazy frame or tibble object
`augment_standard_calendar_dbi()`	Add Comprehensive Date-Based Attributes to a DBI lazy frame
`augment_standard_calendar_tbl()`	Add Comprehensive Date-Based Attributes to a Data Frame
`calculate()`	Execute time-intelligence or segments class objects to return the underlying tra
`cohort()`	Cohort Analysis
`cohort_fn()`	Internal function for the cohort segment object
`complete_standard_calendar()`	Title
`create_calendar()`	Create Calendar Table
`create_full_dbi()`	Title
`detect_sql_dialect()`	Detect SQL dialect from a DBI connection
`dod()`	Current period day over previous period day
`dod_fn()`	Day-over-day execution function
`generate_cli_action()`	Generate CLI actions
`generate_retail_calendar()`	Generate a retail (4-4-5, 4-5-4, or 5-4-4) calendar mapping table
`is_yyyy_mm_dd()`	Validate an input is YYYY-MM-DD format
`make_action_cli()`	Make Action field CLI args
`make_db_tbl()`	Make an in memory database from a table
`mom()`	Current full period month over previous full period month
`mom_fn()`	month-over-month execution function
`momtd()`	Current period month to date compared to previous period month-to-date
`momtd_fn()`	Current year to date over previous year-to-date for tibble objects
`mtd()`	Current period month-to-date
`mtd_fn()`	Month-to-date execution function
`mtdopm()`	Current month-to-date over full previous period month
`mtdopm_fn()`	Month-to-date over full previous month execution function
`pmtd()`	Previous period month-to-date
`pmtd_fn()`	Previous month-to-date execution function
`pqtd()`	Prior period quarter-to-date
`pqtd_fn()`	Previous quarter-to-date for tibble objects
`print()`	Print ti objects
`print_actions_steps()`	Print action steps
`print_calendar_info()`	Print calendar information block
`print_fn_info()`	Prints function header info
`print_next_steps()`	Prints functions next steps
`pwtd()`	Previous period week-to-date
`pwtd_fn()`	Previous week-to-date execution function
`pytd()`	Previous period year-to-date
`pytd_fn()`	Previous year-to-date execution function
`qoq()`	Current full period quarter over previous full period quarter
`qoq_fn()`	Quarter-over-quarter execution function
`qoqtd()`	Current period quarter-to-date compared to previous period quarter-to-date
`qoqtd_fn()`	Current quarter to date over previous quarter-to-date for tibble objects
`qtd()`	Current period quarter-to-date
`qtd_fn()`	Quarter-to-date execution function
`qtdopq()`	Current period quarter-to-date over previous period quarter
`qtdopq_fn()`	quarter-to-date over previous quarter execution function
`seq_date_sql()`	Generate a Cross-Dialect SQL Date Series
`sql_date_add()`	Generate dialect-appropriate date addition SQL
`wow()`	Current full period week over full previous period week
`wow_fn()`	Week-over-week execution function
`wowtd()`	Current period Week-to-date over previous period week-to-date
`wowtd_fn()`	Week-to-date over previous week-to-date execution function
`wtd()`	Current period week-to-date
`wtd_fn()`	Week-to-date execution function
`wtdopw()`	Current period week-to-date over full previous period week
`wtdopw_fn()`	Week-to-date over full previous week execution function
`yoy()`	Current full period year over previous full period year
`yoy_fn()`	Current year-to-date over previous period year-to-date execution function
`yoytd()`	Current period year-to-date compared to previous period year-to-date
`yoytd_fn()`	Current year to date over previous year-to-date execution function
`ytd()`	Current period year-to-date
`ytd_fn()`	Year-to-date execution function
`ytdopy()`	Current period year-to-date compared to full previous period
`ytdopy_fn()`	Year-to-date over full prior period year