year-day-group {clock}R Documentation

Grouping: year-day

Description

This is a year-day method for the calendar_group() generic.

Grouping for a year-day object can be done at any precision, as long as x is at least as precise as precision.

Usage

## S3 method for class 'clock_year_day'
calendar_group(x, precision, ..., n = 1L)

Arguments

x

⁠[clock_year_day]⁠

A year-day vector.

precision

⁠[character(1)]⁠

One of:

  • "year"

  • "day"

  • "hour"

  • "minute"

  • "second"

  • "millisecond"

  • "microsecond"

  • "nanosecond"

...

These dots are for future extensions and must be empty.

n

⁠[positive integer(1)]⁠

A single positive integer specifying a multiple of precision to use.

Value

x grouped at the specified precision.

Examples

x <- seq(as_naive_time(year_month_day(2019, 1, 1)), by = 5, length.out = 20)
x <- as_year_day(x)
x

# Group by day of the current year
calendar_group(x, "day", n = 20)

[Package clock version 0.6.0 Index]