year-month-weekday-setters {clock}R Documentation

Setters: year-month-weekday

Description

These are year-month-weekday methods for the setter generics.

Usage

## S3 method for class 'clock_year_month_weekday'
set_year(x, value, ...)

## S3 method for class 'clock_year_month_weekday'
set_month(x, value, ...)

## S3 method for class 'clock_year_month_weekday'
set_day(x, value, ..., index = NULL)

## S3 method for class 'clock_year_month_weekday'
set_index(x, value, ...)

## S3 method for class 'clock_year_month_weekday'
set_hour(x, value, ...)

## S3 method for class 'clock_year_month_weekday'
set_minute(x, value, ...)

## S3 method for class 'clock_year_month_weekday'
set_second(x, value, ...)

## S3 method for class 'clock_year_month_weekday'
set_millisecond(x, value, ...)

## S3 method for class 'clock_year_month_weekday'
set_microsecond(x, value, ...)

## S3 method for class 'clock_year_month_weekday'
set_nanosecond(x, value, ...)

Arguments

x

⁠[clock_year_month_weekday]⁠

A year-month-weekday vector.

value

⁠[integer / "last"]⁠

The value to set the component to.

For set_index(), this can also be "last" to adjust to the last instance of the corresponding weekday in that month.

...

These dots are for future extensions and must be empty.

index

⁠[NULL / integer / "last"]⁠

This argument is only used with set_day(), and allows you to set the index while also setting the weekday.

If x is a month precision year-month-weekday, index is required to be set, as you must specify the weekday and the index simultaneously to promote from month to day precision.

Value

x with the component set.

Examples

x <- year_month_weekday(2019, 1:3)

set_year(x, 2020:2022)

# Setting the weekday on a month precision year-month-weekday requires
# also setting the `index` to fully specify the day information
x <- set_day(x, clock_weekdays$sunday, index = 1)
x

# Once you have at least day precision, you can set the weekday and
# the index separately
set_day(x, clock_weekdays$monday)
set_index(x, 3)

# Set to the "last" instance of the corresponding weekday in this month
# (Note that some months have 4 Sundays, and others have 5)
set_index(x, "last")

# Set to an invalid index
# January and February of 2019 don't have 5 Sundays!
invalid <- set_index(x, 5)
invalid

# Resolve the invalid dates by choosing the previous/next valid moment
invalid_resolve(invalid, invalid = "previous")
invalid_resolve(invalid, invalid = "next")

# You can also "overflow" the index. This keeps the weekday, but resets
# the index to 1 and increments the month value by 1.
invalid_resolve(invalid, invalid = "overflow")

[Package clock version 0.6.0 Index]