Skip to contents

ISO 8601 time unit classes

Source: R/cal_isoweek.R
calendar_isoweek.Rd

Time unit constructors for the ISO 8601 calendar system. These units can be used with linear_time() to create custom time representations.

Usage

cal_isoweek

Format

A civil-based calendar containing ISO 8601 time units.

Value

An S3 list of class c("cal_isoweek", "mt_calendar") containing the named time unit classes of the ISO 8601 week calendar. Each unit is accessible via $ notation and calling it with a step size produces a time granule (e.g., 1 week granule as cal_isoweek$week(1L)).

Details

The following time units are available in the ISO week date calendar:

  • year(): ISO year unit (years start on the week containing the first Thursday)

  • week(): Week unit (7-day periods)

  • day(): Day unit

  • hour(): Hour unit

  • minute(): Minute unit

  • second(): Second unit

  • millisecond(): Millisecond unit

ISO 8601 weeks always start on Monday and the first week of a year is the week containing the first Thursday of that year. This means that some days in early January may belong to the last week of the previous ISO year, and some days in late December may belong to the first week of the next ISO year.

See also

linear_time() for creating custom time representations, yearweek() for a pre-defined ISO 8601 year-week representation