Skip to content

Generate a date range

Source code

Description

If both start and end are passed as the Date types (not Datetime), and the interval granularity is no finer than “1d”, the returned range is also of type Date. All other permutations return a Datetime. Note that in a future version of Polars, pl$date_range() will always return Date. Please use pl$datetime_range() if you want Datetime instead.

Usage

pl$date_range(
  start,
  end,
  interval = "1d",
  ...,
  closed = "both",
  time_unit = NULL,
  time_zone = NULL
)

Arguments

start Lower bound of the date range. Something that can be coerced to a Date or a Datetime expression. See examples for details.
end Upper bound of the date range. Something that can be coerced to a Date or a Datetime expression. See examples for details.
interval Interval of the range periods, specified as a difftime object or using the Polars duration string language. See the Polars duration string language section for details.
… Ignored.
closed Define which sides of the range are closed (inclusive). One of the followings: “both” (default), “left”, “right”, “none”.
time_unit Time unit of the resulting the Datetime data type. One of “ns”, “us”, “ms” or NULL. Only takes effect if the output column is of type Datetime (deprecated usage).
time_zone Time zone of the resulting Datetime data type. Only takes effect if the output column is of type Datetime (deprecated usage).

Value

An Expr of data type Date or Datetime

Polars duration string language

Polars duration string language is a simple representation of durations. It is used in many Polars functions that accept durations.

It has the following format:

  • 1ns (1 nanosecond)
  • 1us (1 microsecond)
  • 1ms (1 millisecond)
  • 1s (1 second)
  • 1m (1 minute)
  • 1h (1 hour)
  • 1d (1 calendar day)
  • 1w (1 calendar week)
  • 1mo (1 calendar month)
  • 1q (1 calendar quarter)
  • 1y (1 calendar year)

Or combine them: “3d12h4m25s” # 3 days, 12 hours, 4 minutes, and 25 seconds

By "calendar day", we mean the corresponding time on the next day (which may not be 24 hours, due to daylight savings). Similarly for "calendar week", "calendar month", "calendar quarter", and "calendar year".

See Also

pl$date_ranges() to create a simple Series of data type list(Date) based on column values.

Examples

library(polars)

# Using Polars duration string to specify the interval:
pl$date_range(as.Date("2022-01-01"), as.Date("2022-03-01"), "1mo") |>
  as_polars_series("date")

#> polars Series: shape: (3,)
#> Series: 'date' [date]
#> [
#>  2022-01-01
#>  2022-02-01
#>  2022-03-01
#> ]

# Using `difftime` object to specify the interval:
pl$date_range(
  as.Date("1985-01-01"),
  as.Date("1985-01-10"),
  as.difftime(2, units = "days")
) |>
  as_polars_series("date")

#> polars Series: shape: (5,)
#> Series: 'date' [date]
#> [
#>  1985-01-01
#>  1985-01-03
#>  1985-01-05
#>  1985-01-07
#>  1985-01-09
#> ]