R: Date-Time Types and Tools

# Date-Time Types and Tools

## Documentation for package ‘clock’ version 0.6.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

A C D F G I N P S T V W Y Z

## -- A --

add_days | Clock arithmetic
add_days.clock_duration | Arithmetic: duration
add_days.clock_time_point | Arithmetic: Time points
add_days.clock_weekday | Arithmetic: weekday
add_days.Date | Arithmetic: date
add_days.POSIXt | Arithmetic: date-time
add_hours | Clock arithmetic
add_hours.clock_duration | Arithmetic: duration
add_hours.clock_time_point | Arithmetic: Time points
add_hours.POSIXt | Arithmetic: date-time
add_microseconds | Clock arithmetic
add_microseconds.clock_duration | Arithmetic: duration
add_microseconds.clock_time_point | Arithmetic: Time points
add_milliseconds | Clock arithmetic
add_milliseconds.clock_duration | Arithmetic: duration
add_milliseconds.clock_time_point | Arithmetic: Time points
add_minutes | Clock arithmetic
add_minutes.clock_duration | Arithmetic: duration
add_minutes.clock_time_point | Arithmetic: Time points
add_minutes.POSIXt | Arithmetic: date-time
add_months | Clock arithmetic
add_months.clock_duration | Arithmetic: duration
add_months.clock_year_month_day | Arithmetic: year-month-day
add_months.clock_year_month_weekday | Arithmetic: year-month-weekday
add_months.Date | Arithmetic: date
add_months.POSIXt | Arithmetic: date-time
add_nanoseconds | Clock arithmetic
add_nanoseconds.clock_duration | Arithmetic: duration
add_nanoseconds.clock_time_point | Arithmetic: Time points
add_quarters | Clock arithmetic
add_quarters.clock_duration | Arithmetic: duration
add_quarters.clock_year_month_day | Arithmetic: year-month-day
add_quarters.clock_year_month_weekday | Arithmetic: year-month-weekday
add_quarters.clock_year_quarter_day | Arithmetic: year-quarter-day
add_quarters.Date | Arithmetic: date
add_quarters.POSIXt | Arithmetic: date-time
add_seconds | Clock arithmetic
add_seconds.clock_duration | Arithmetic: duration
add_seconds.clock_time_point | Arithmetic: Time points
add_seconds.POSIXt | Arithmetic: date-time
add_weeks | Clock arithmetic
add_weeks.clock_duration | Arithmetic: duration
add_weeks.clock_time_point | Arithmetic: Time points
add_weeks.Date | Arithmetic: date
add_weeks.POSIXt | Arithmetic: date-time
add_years | Clock arithmetic
add_years.clock_duration | Arithmetic: duration
add_years.clock_iso_year_week_day | Arithmetic: iso-year-week-day
add_years.clock_year_day | Arithmetic: year-day
add_years.clock_year_month_day | Arithmetic: year-month-day
add_years.clock_year_month_weekday | Arithmetic: year-month-weekday
add_years.clock_year_quarter_day | Arithmetic: year-quarter-day
add_years.Date | Arithmetic: date
add_years.POSIXt | Arithmetic: date-time
as-zoned-time-Date | Convert to a zoned-time from a date
as-zoned-time-naive-time | Convert to a zoned-time from a naive-time
as-zoned-time-posixt | Convert to a zoned-time from a date-time
as-zoned-time-sys-time | Convert to a zoned-time from a sys-time
as_date | Convert to a date
as_date.clock_calendar | Convert to a date
as_date.clock_time_point | Convert to a date
as_date.clock_zoned_time | Convert to a date
as_date.Date | Convert to a date
as_date.POSIXt | Convert to a date
as_date_time | Convert to a date-time
as_date_time.clock_calendar | Convert to a date-time
as_date_time.clock_naive_time | Convert to a date-time
as_date_time.clock_sys_time | Convert to a date-time
as_date_time.clock_zoned_time | Convert to a date-time
as_date_time.Date | Convert to a date-time
as_date_time.POSIXt | Convert to a date-time
as_duration | Convert to a duration
as_iso_year_week_day | Convert to iso-year-week-day
as_naive_time | Convert to a naive-time
as_sys_time | Convert to a sys-time
as_weekday | Convert to a weekday
as_year_day | Convert to year-day
as_year_month_day | Convert to year-month-day
as_year_month_weekday | Convert to year-month-weekday
as_year_quarter_day | Convert to year-quarter-day
as_zoned_time | Convert to a zoned-time
as_zoned_time.clock_naive_time | Convert to a zoned-time from a naive-time
as_zoned_time.clock_sys_time | Convert to a zoned-time from a sys-time
as_zoned_time.Date | Convert to a zoned-time from a date
as_zoned_time.POSIXt | Convert to a zoned-time from a date-time

## -- C --

calendar-boundary | Boundaries: calendars
calendar-count-between | Counting: calendars
calendar_count_between | Counting: calendars
calendar_count_between.clock_iso_year_week_day | Counting: iso-year-week-day
calendar_count_between.clock_year_day | Counting: year-day
calendar_count_between.clock_year_month_day | Counting: year-month-day
calendar_count_between.clock_year_month_weekday | Counting: year-month-weekday
calendar_count_between.clock_year_quarter_day | Counting: year-quarter-day
calendar_end | Boundaries: calendars
calendar_end.clock_iso_year_week_day | Boundaries: iso-year-week-day
calendar_end.clock_year_day | Boundaries: year-day
calendar_end.clock_year_month_day | Boundaries: year-month-day
calendar_end.clock_year_month_weekday | Boundaries: year-month-weekday
calendar_end.clock_year_quarter_day | Boundaries: year-quarter-day
calendar_group | Group calendar components
calendar_group.clock_iso_year_week_day | Grouping: iso-year-week-day
calendar_group.clock_year_day | Grouping: year-day
calendar_group.clock_year_month_day | Grouping: year-month-day
calendar_group.clock_year_month_weekday | Grouping: year-month-weekday
calendar_group.clock_year_quarter_day | Grouping: year-quarter-day
calendar_leap_year | Is the calendar year a leap year?
calendar_month_factor | Convert a calendar to an ordered factor of month names
calendar_narrow | Narrow a calendar to a less precise precision
calendar_narrow.clock_iso_year_week_day | Narrow: iso-year-week-day
calendar_narrow.clock_year_day | Narrow: year-day
calendar_narrow.clock_year_month_day | Narrow: year-month-day
calendar_narrow.clock_year_month_weekday | Narrow: year-month-weekday
calendar_narrow.clock_year_quarter_day | Narrow: year-quarter-day
calendar_precision | Precision: calendar
calendar_start | Boundaries: calendars
calendar_start.clock_iso_year_week_day | Boundaries: iso-year-week-day
calendar_start.clock_year_day | Boundaries: year-day
calendar_start.clock_year_month_day | Boundaries: year-month-day
calendar_start.clock_year_month_weekday | Boundaries: year-month-weekday
calendar_start.clock_year_quarter_day | Boundaries: year-quarter-day
calendar_widen | Widen a calendar to a more precise precision
calendar_widen.clock_iso_year_week_day | Widen: iso-year-week-day
calendar_widen.clock_year_day | Widen: year-day
calendar_widen.clock_year_month_day | Widen: year-month-day
calendar_widen.clock_year_month_weekday | Widen: year-month-weekday
calendar_widen.clock_year_quarter_day | Widen: year-quarter-day
clock-arith | Support for vctrs arithmetic
clock-arithmetic | Clock arithmetic
clock-codes | Integer codes
clock-getters | Calendar getters
clock-invalid | Invalid calendar dates
clock-setters | Calendar setters
clock_iso_weekdays | Integer codes
clock_labels | Create or retrieve date related labels
clock_labels_languages | Create or retrieve date related labels
clock_labels_lookup | Create or retrieve date related labels
clock_locale | Create a clock locale
clock_months | Integer codes
clock_weekdays | Integer codes

## -- D --

date-and-date-time-boundary | Boundaries: date and date-time
date-and-date-time-rounding | Date and date-time rounding
date-and-date-time-shifting | Shifting: date and date-time
Date-arithmetic | Arithmetic: date
date-boundary | Boundaries: date
date-count-between | Counting: date
date-formatting | Formatting: date
Date-getters | Getters: date
date-group | Group date components
date-rounding | Rounding: date
date-sequence | Sequences: date
Date-setters | Setters: date
date-shifting | Shifting: date
date-time-parse | Parsing: date-time
date-today | Current date and date-time
date-zone | Get or set the time zone
date_build | Building: date
date_ceiling | Date and date-time rounding
date_ceiling.Date | Rounding: date
date_ceiling.POSIXt | Rounding: date-time
date_count_between | Counting: date and date-time
date_count_between.Date | Counting: date
date_count_between.POSIXt | Counting: date-times
date_end | Boundaries: date and date-time
date_end.Date | Boundaries: date
date_end.POSIXt | Boundaries: date-time
date_floor | Date and date-time rounding
date_floor.Date | Rounding: date
date_floor.POSIXt | Rounding: date-time
date_format | Formatting: date and date-time
date_format.Date | Formatting: date
date_format.POSIXt | Formatting: date-time
date_group | Group date and date-time components
date_group.Date | Group date components
date_group.POSIXt | Group date-time components
date_leap_year | Is the year a leap year?
date_month_factor | Convert a date or date-time to an ordered factor of month names
date_now | Current date and date-time
date_parse | Parsing: date
date_round | Date and date-time rounding
date_round.Date | Rounding: date
date_round.POSIXt | Rounding: date-time
date_seq | Sequences: date and date-time
date_seq.Date | Sequences: date
date_seq.POSIXt | Sequences: date-time
date_set_zone | Get or set the time zone
date_shift | Shifting: date and date-time
date_shift.Date | Shifting: date
date_shift.POSIXt | Shifting: date and date-time
date_start | Boundaries: date and date-time
date_start.Date | Boundaries: date
date_start.POSIXt | Boundaries: date-time
date_time_build | Building: date-time
date_time_parse | Parsing: date-time
date_time_parse_abbrev | Parsing: date-time
date_time_parse_complete | Parsing: date-time
date_time_parse_RFC_3339 | Parsing: date-time
date_today | Current date and date-time
date_weekday_factor | Convert a date or date-time to a weekday factor
date_zone | Get or set the time zone
duration-arithmetic | Arithmetic: duration
duration-helper | Construct a duration
duration-rounding | Duration rounding
duration_cast | Cast a duration between precisions
duration_ceiling | Duration rounding
duration_days | Construct a duration
duration_floor | Duration rounding
duration_hours | Construct a duration
duration_microseconds | Construct a duration
duration_milliseconds | Construct a duration
duration_minutes | Construct a duration
duration_months | Construct a duration
duration_nanoseconds | Construct a duration
duration_precision | Precision: duration
duration_quarters | Construct a duration
duration_round | Duration rounding
duration_seconds | Construct a duration
duration_weeks | Construct a duration
duration_years | Construct a duration

## -- F --

format.clock_zoned_time | Formatting: zoned-time

## -- G --

get_day | Calendar getters
get_day.clock_iso_year_week_day | Getters: iso-year-week-day
get_day.clock_year_day | Getters: year-day
get_day.clock_year_month_day | Getters: year-month-day
get_day.clock_year_month_weekday | Getters: year-month-weekday
get_day.clock_year_quarter_day | Getters: year-quarter-day
get_day.Date | Getters: date
get_day.POSIXt | Getters: date-time
get_hour | Calendar getters
get_hour.clock_iso_year_week_day | Getters: iso-year-week-day
get_hour.clock_year_day | Getters: year-day
get_hour.clock_year_month_day | Getters: year-month-day
get_hour.clock_year_month_weekday | Getters: year-month-weekday
get_hour.clock_year_quarter_day | Getters: year-quarter-day
get_hour.POSIXt | Getters: date-time
get_index | Calendar getters
get_index.clock_year_month_weekday | Getters: year-month-weekday
get_microsecond | Calendar getters
get_microsecond.clock_iso_year_week_day | Getters: iso-year-week-day
get_microsecond.clock_year_day | Getters: year-day
get_microsecond.clock_year_month_day | Getters: year-month-day
get_microsecond.clock_year_month_weekday | Getters: year-month-weekday
get_microsecond.clock_year_quarter_day | Getters: year-quarter-day
get_millisecond | Calendar getters
get_millisecond.clock_iso_year_week_day | Getters: iso-year-week-day
get_millisecond.clock_year_day | Getters: year-day
get_millisecond.clock_year_month_day | Getters: year-month-day
get_millisecond.clock_year_month_weekday | Getters: year-month-weekday
get_millisecond.clock_year_quarter_day | Getters: year-quarter-day
get_minute | Calendar getters
get_minute.clock_iso_year_week_day | Getters: iso-year-week-day
get_minute.clock_year_day | Getters: year-day
get_minute.clock_year_month_day | Getters: year-month-day
get_minute.clock_year_month_weekday | Getters: year-month-weekday
get_minute.clock_year_quarter_day | Getters: year-quarter-day
get_minute.POSIXt | Getters: date-time
get_month | Calendar getters
get_month.clock_year_month_day | Getters: year-month-day
get_month.clock_year_month_weekday | Getters: year-month-weekday
get_month.Date | Getters: date
get_month.POSIXt | Getters: date-time
get_nanosecond | Calendar getters
get_nanosecond.clock_iso_year_week_day | Getters: iso-year-week-day
get_nanosecond.clock_year_day | Getters: year-day
get_nanosecond.clock_year_month_day | Getters: year-month-day
get_nanosecond.clock_year_month_weekday | Getters: year-month-weekday
get_nanosecond.clock_year_quarter_day | Getters: year-quarter-day
get_quarter | Calendar getters
get_quarter.clock_year_quarter_day | Getters: year-quarter-day
get_second | Calendar getters
get_second.clock_iso_year_week_day | Getters: iso-year-week-day
get_second.clock_year_day | Getters: year-day
get_second.clock_year_month_day | Getters: year-month-day
get_second.clock_year_month_weekday | Getters: year-month-weekday
get_second.clock_year_quarter_day | Getters: year-quarter-day
get_second.POSIXt | Getters: date-time
get_week | Calendar getters
get_week.clock_iso_year_week_day | Getters: iso-year-week-day
get_year | Calendar getters
get_year.clock_iso_year_week_day | Getters: iso-year-week-day
get_year.clock_year_day | Getters: year-day
get_year.clock_year_month_day | Getters: year-month-day
get_year.clock_year_month_weekday | Getters: year-month-weekday
get_year.clock_year_quarter_day | Getters: year-quarter-day
get_year.Date | Getters: date
get_year.POSIXt | Getters: date-time

## -- I --

invalid_any | Invalid calendar dates
invalid_count | Invalid calendar dates
invalid_detect | Invalid calendar dates
invalid_remove | Invalid calendar dates
invalid_resolve | Invalid calendar dates
iso-year-week-day-arithmetic | Arithmetic: iso-year-week-day
iso-year-week-day-boundary | Boundaries: iso-year-week-day
iso-year-week-day-count-between | Counting: iso-year-week-day
iso-year-week-day-getters | Getters: iso-year-week-day
iso-year-week-day-group | Grouping: iso-year-week-day
iso-year-week-day-narrow | Narrow: iso-year-week-day
iso-year-week-day-setters | Setters: iso-year-week-day
iso-year-week-day-widen | Widen: iso-year-week-day
iso_year_week_day | Calendar: iso-year-week-day
is_duration | Is 'x' a duration?
is_iso_year_week_day | Is 'x' a iso-year-week-day?
is_naive_time | Is 'x' a naive-time?
is_sys_time | Is 'x' a sys-time?
is_weekday | Is 'x' a weekday?
is_year_day | Is 'x' a year-day?
is_year_month_day | Is 'x' a year-month-day?
is_year_month_weekday | Is 'x' a year-month-weekday?
is_year_quarter_day | Is 'x' a year-quarter-day?
is_zoned_time | Is 'x' a zoned-time?

## -- N --

naive_time_info | Info: naive-time
naive_time_parse | Parsing: naive-time

## -- P --

posixt-arithmetic | Arithmetic: date-time
posixt-boundary | Boundaries: date-time
posixt-count-between | Counting: date-times
posixt-formatting | Formatting: date-time
posixt-getters | Getters: date-time
posixt-group | Group date-time components
posixt-rounding | Rounding: date-time
posixt-sequence | Sequences: date-time
posixt-setters | Setters: date-time
posixt-shifting | Shifting: date and date-time

## -- S --

seq.clock_duration | Sequences: duration
seq.clock_iso_year_week_day | Sequences: iso-year-week-day
seq.clock_time_point | Sequences: time points
seq.clock_year_day | Sequences: year-day
seq.clock_year_month_day | Sequences: year-month-day
seq.clock_year_month_weekday | Sequences: year-month-weekday
seq.clock_year_quarter_day | Sequences: year-quarter-day
set_day | Calendar setters
set_day.clock_iso_year_week_day | Setters: iso-year-week-day
set_day.clock_year_day | Setters: year-day
set_day.clock_year_month_day | Setters: year-month-day
set_day.clock_year_month_weekday | Setters: year-month-weekday
set_day.clock_year_quarter_day | Setters: year-quarter-day
set_day.Date | Setters: date
set_day.POSIXt | Setters: date-time
set_hour | Calendar setters
set_hour.clock_iso_year_week_day | Setters: iso-year-week-day
set_hour.clock_year_day | Setters: year-day
set_hour.clock_year_month_day | Setters: year-month-day
set_hour.clock_year_month_weekday | Setters: year-month-weekday
set_hour.clock_year_quarter_day | Setters: year-quarter-day
set_hour.POSIXt | Setters: date-time
set_index | Calendar setters
set_index.clock_year_month_weekday | Setters: year-month-weekday
set_microsecond | Calendar setters
set_microsecond.clock_iso_year_week_day | Setters: iso-year-week-day
set_microsecond.clock_year_day | Setters: year-day
set_microsecond.clock_year_month_day | Setters: year-month-day
set_microsecond.clock_year_month_weekday | Setters: year-month-weekday
set_microsecond.clock_year_quarter_day | Setters: year-quarter-day
set_millisecond | Calendar setters
set_millisecond.clock_iso_year_week_day | Setters: iso-year-week-day
set_millisecond.clock_year_day | Setters: year-day
set_millisecond.clock_year_month_day | Setters: year-month-day
set_millisecond.clock_year_month_weekday | Setters: year-month-weekday
set_millisecond.clock_year_quarter_day | Setters: year-quarter-day
set_minute | Calendar setters
set_minute.clock_iso_year_week_day | Setters: iso-year-week-day
set_minute.clock_year_day | Setters: year-day
set_minute.clock_year_month_day | Setters: year-month-day
set_minute.clock_year_month_weekday | Setters: year-month-weekday
set_minute.clock_year_quarter_day | Setters: year-quarter-day
set_minute.POSIXt | Setters: date-time
set_month | Calendar setters
set_month.clock_year_month_day | Setters: year-month-day
set_month.clock_year_month_weekday | Setters: year-month-weekday
set_month.Date | Setters: date
set_month.POSIXt | Setters: date-time
set_nanosecond | Calendar setters
set_nanosecond.clock_iso_year_week_day | Setters: iso-year-week-day
set_nanosecond.clock_year_day | Setters: year-day
set_nanosecond.clock_year_month_day | Setters: year-month-day
set_nanosecond.clock_year_month_weekday | Setters: year-month-weekday
set_nanosecond.clock_year_quarter_day | Setters: year-quarter-day
set_quarter | Calendar setters
set_quarter.clock_year_quarter_day | Setters: year-quarter-day
set_second | Calendar setters
set_second.clock_iso_year_week_day | Setters: iso-year-week-day
set_second.clock_year_day | Setters: year-day
set_second.clock_year_month_day | Setters: year-month-day
set_second.clock_year_month_weekday | Setters: year-month-weekday
set_second.clock_year_quarter_day | Setters: year-quarter-day
set_second.POSIXt | Setters: date-time
set_week | Calendar setters
set_week.clock_iso_year_week_day | Setters: iso-year-week-day
set_year | Calendar setters
set_year.clock_iso_year_week_day | Setters: iso-year-week-day
set_year.clock_year_day | Setters: year-day
set_year.clock_year_month_day | Setters: year-month-day
set_year.clock_year_month_weekday | Setters: year-month-weekday
set_year.clock_year_quarter_day | Setters: year-quarter-day
set_year.Date | Setters: date
set_year.POSIXt | Setters: date-time
sys-parsing | Parsing: sys-time
sys_time_info | Info: sys-time
sys_time_now | What is the current sys-time?
sys_time_parse | Parsing: sys-time
sys_time_parse_RFC_3339 | Parsing: sys-time

## -- T --

time-point-arithmetic | Arithmetic: Time points
time-point-rounding | Time point rounding
time_point_cast | Cast a time point between precisions
time_point_ceiling | Time point rounding
time_point_count_between | Counting: time point
time_point_floor | Time point rounding
time_point_precision | Precision: time point
time_point_round | Time point rounding
time_point_shift | Shifting: time point

## -- V --

vec_arith.clock_iso_year_week_day | Support for vctrs arithmetic
vec_arith.clock_naive_time | Support for vctrs arithmetic
vec_arith.clock_sys_time | Support for vctrs arithmetic
vec_arith.clock_weekday | Support for vctrs arithmetic
vec_arith.clock_year_day | Support for vctrs arithmetic
vec_arith.clock_year_month_day | Support for vctrs arithmetic
vec_arith.clock_year_month_weekday | Support for vctrs arithmetic
vec_arith.clock_year_quarter_day | Support for vctrs arithmetic

## -- W --

weekday | Construct a weekday vector
weekday-arithmetic | Arithmetic: weekday
weekday_code | Extract underlying weekday codes
weekday_factor | Convert a weekday to an ordered factor

## -- Y --

year-day-arithmetic | Arithmetic: year-day
year-day-boundary | Boundaries: year-day
year-day-count-between | Counting: year-day
year-day-getters | Getters: year-day
year-day-group | Grouping: year-day
year-day-narrow | Narrow: year-day
year-day-setters | Setters: year-day
year-day-widen | Widen: year-day
year-month-day-arithmetic | Arithmetic: year-month-day
year-month-day-boundary | Boundaries: year-month-day
year-month-day-count-between | Counting: year-month-day
year-month-day-getters | Getters: year-month-day
year-month-day-group | Grouping: year-month-day
year-month-day-narrow | Narrow: year-month-day
year-month-day-setters | Setters: year-month-day
year-month-day-widen | Widen: year-month-day
year-month-weekday-arithmetic | Arithmetic: year-month-weekday
year-month-weekday-boundary | Boundaries: year-month-weekday
year-month-weekday-count-between | Counting: year-month-weekday
year-month-weekday-getters | Getters: year-month-weekday
year-month-weekday-group | Grouping: year-month-weekday
year-month-weekday-narrow | Narrow: year-month-weekday
year-month-weekday-setters | Setters: year-month-weekday
year-month-weekday-widen | Widen: year-month-weekday
year-quarter-day-arithmetic | Arithmetic: year-quarter-day
year-quarter-day-boundary | Boundaries: year-quarter-day
year-quarter-day-count-between | Counting: year-quarter-day
year-quarter-day-getters | Getters: year-quarter-day
year-quarter-day-group | Grouping: year-quarter-day
year-quarter-day-narrow | Narrow: year-quarter-day
year-quarter-day-setters | Setters: year-quarter-day
year-quarter-day-widen | Widen: year-quarter-day
year_day | Calendar: year-day
year_month_day | Calendar: year-month-day
year_month_day_parse | Parsing: year-month-day
year_month_weekday | Calendar: year-month-weekday
year_quarter_day | Calendar: year-quarter-day

## -- Z --

zoned-parsing | Parsing: zoned-time
zoned-zone | Get or set the time zone
zoned_time_now | What is the current zoned-time?
zoned_time_parse_abbrev | Parsing: zoned-time
zoned_time_parse_complete | Parsing: zoned-time
zoned_time_precision | Precision: zoned-time
zoned_time_set_zone | Get or set the time zone
zoned_time_zone | Get or set the time zone