date_seq {clock}R Documentation

Sequences: date and date-time

Description

date_seq() generates a date (Date) or date-time (POSIXct/POSIXlt) sequence.

There are separate help pages for generating sequences for dates and date-times:

Usage

date_seq(from, ..., to = NULL, by = NULL, total_size = NULL)

Arguments

from

⁠[Date(1) / POSIXct(1) / POSIXlt(1)]⁠

A date or date-time to start the sequence from.

from is always included in the result.

...

These dots are for future extensions and must be empty.

to

⁠[Date(1) / POSIXct(1) / POSIXlt(1) / NULL]⁠

A date or date-time to stop the sequence at.

to is only included in the result if the resulting sequence divides the distance between from and to exactly.

by

⁠[integer(1) / clock_duration(1) / NULL]⁠

The unit to increment the sequence by.

If to < from, then by must be positive.

If to > from, then by must be negative.

total_size

⁠[positive integer(1) / NULL]⁠

The size of the resulting sequence.

If specified alongside to, this must generate a non-fractional sequence between from and to.

Value

A date or date-time vector.

Examples

# See method specific documentation for more examples

x <- as.Date("2019-01-01")
date_seq(x, by = duration_months(2), total_size = 20)

[Package clock version 0.6.0 Index]