year-month-day-widen: Widen: year-month-day

year-month-day-widenR Documentation

Widen: year-month-day

Description

This is a year-month-day method for the calendar_widen() generic. It widens a year-month-day vector to the specified precision.

Usage

## S3 method for class 'clock_year_month_day'
calendar_widen(x, precision)

Arguments

x

⁠[clock_year_month_day]⁠

A year-month-day vector.

precision

⁠[character(1)]⁠

One of:

  • "year"

  • "month"

  • "day"

  • "hour"

  • "minute"

  • "second"

  • "millisecond"

  • "microsecond"

  • "nanosecond"

Value

x widened to the supplied precision.

Examples

# Month precision
x <- year_month_day(2019, 1)
x

# Widen to day precision
calendar_widen(x, "day")

# Or second precision
sec <- calendar_widen(x, "second")
sec

# Second precision can be widened to subsecond precision
milli <- calendar_widen(sec, "millisecond")
micro <- calendar_widen(sec, "microsecond")
milli
micro

# But once you have "locked in" a subsecond precision, it can't
# be widened again
try(calendar_widen(milli, "microsecond"))

clock documentation built on Sept. 11, 2024, 8:39 p.m.