wtd

< Back to Reference | View source

wtd()

Current period week-to-date

Usage

wtd(.data, .date, .value, calendar_type = "standard", fiscal_year_start = 1)

Arguments

Argument Description
.data tibble or dbi object (either grouped or ungrouped)
.date the date column to group by
.value the value column to summarize
calendar_type select either ‘standard’, ‘445’, ‘454’, or ‘544’ calendar, see ‘Details’ for additional information
fiscal_year_start integer 1-12, the month the fiscal year starts nearest to (default 1 = January). Only used with retail calendars (‘445’, ‘454’, ‘544’).

Value

ti object

Description

This calculates the weekly cumulative sum of targeted value using a standard or 5-5-4 calendar respecting any groups that are passed through with dplyr::group_by()

Use calculate to return the results

Details

  • This function creates a complete calendar object that fills in any missing days, weeks, months, quarters, or years

  • If you provide a grouped object with dplyr::group_by(), it will generate a complete calendar for each group

  • The function creates a ti object, which pre-processes the data and arguments for further downstream functions

standard calendar

  • The standard calendar splits the year into 12 months (with 28–31 days each) and uses a 7-day week

  • It automatically accounts for leap years every four years to match the Gregorian calendar

5-5-4 calendar

  • The 5-5-4 calendar divides the fiscal year into 52 weeks (occasionally 53), organizing each quarter into two 5-week periods and one 4-week period.

  • This system is commonly used in retail and financial reporting

Examples

wtd(contoso::sales,.date=order_date,.value=quantity,calendar_type="standard")

See also

Other time_intelligence: atd(), dod(), mom(), momtd(), mtd(), mtdopm(), pmtd(), pqtd(), pwtd(), pytd(), qoq(), qoqtd(), qtd(), qtdopq(), wow(), wowtd(), wtdopw(), yoy(), yoytd(), ytd(), ytdopy()