seq.clock_duration: Sequences: duration

In clock: Date-Time Types and Tools

Sequences: duration

Description

This is a duration method for the seq() generic.

Using seq() on duration objects always retains the type of from.

When calling seq(), exactly two of the following must be specified:

• to

• by

• Either length.out or along.with

Usage

## S3 method for class 'clock_duration'
seq(from, to = NULL, by = NULL, length.out = NULL, along.with = NULL, ...)

Arguments

from	⁠[clock_duration(1)]⁠ A duration to start the sequence from.
to	⁠[clock_duration(1) / NULL]⁠ A duration to stop the sequence at. to is cast to the type of from. 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 by is an integer, it is transformed into a duration with the precision of from. If by is a duration, it is cast to the type of from.
length.out	⁠[positive integer(1) / NULL]⁠ The length of the resulting sequence. If specified, along.with must be NULL.
along.with	⁠[vector / NULL]⁠ A vector who's length determines the length of the resulting sequence. Equivalent to length.out = vec_size(along.with). If specified, length.out must be NULL.
...	These dots are for future extensions and must be empty.

Details

If from > to and by > 0, then the result will be length 0. This matches the behavior of rlang::seq2(), and results in nicer theoretical properties when compared with throwing an error. Similarly, if from < to and by < 0, then the result will also be length 0.

Value

A sequence with the type of from.

Examples

seq(duration_days(0), duration_days(100), by = 5)

# Using a duration `by`. Note that `by` is cast to the type of `from`.
seq(duration_days(0), duration_days(100), by = duration_weeks(1))

# `to` is cast from 5 years to 60 months
# `by` is cast from 1 quarter to 4 months
seq(duration_months(0), duration_years(5), by = duration_quarters(1))

seq(duration_days(20), by = 2, length.out = 5)

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