Additional datetime extractors — weekdays.datetimeoffset • datetimeoffset

Additional datetime extractors for datetimeoffset() objects.

Usage

# S3 method for class 'datetimeoffset'
weekdays(x, abbreviate = FALSE)

# S3 method for class 'datetimeoffset'
months(x, abbreviate = FALSE)

# S3 method for class 'datetimeoffset'
quarters(x, ...)

# S3 method for class 'datetimeoffset'
julian(x, origin = as.Date("1970-01-01"), ...)

Arguments

x: A datetimeoffset() datetime
abbreviate: Logical vector for whether the names should be abbreviated
...: Ignored
origin: Length one datetime of origin

Value

weekdays(), months(), quarters(), julian() return character vectors. See base::weekdays() for more information.

Details

We implement datetimeoffset() support for the following S3 methods from base:

There is also datetimeoffset() support for the following methods from lubridate:

isoyear() and epiyear()
quarter() and semester()
week(), isoweek(), and epiweek()
wday() and wday<-()
qday() and qday<-()
yday() and yday<-()
am() and pm()
days_in_month()
dst()
leap_year()

Examples

dto <- datetimeoffset_now()
print(dto)
#> <datetimeoffset[1]>
#> [1] 2025-03-24T09:52:33.189176088-07:00[America/Los_Angeles]
weekdays(dto)
#> [1] "Monday"
months(dto)
#> [1] "March"
quarters(dto)
#> [1] "Q1"
julian(dto)
#> [1] 20171
#> attr(,"origin")
#> [1] "1970-01-01"

if (require("lubridate")) {
  cat("`isoyear(dto)`: ", isoyear(dto), "\n")
  cat("`epiyear(dto)`: ", epiyear(dto), "\n")
  cat("`semester(dto)`: ", semester(dto), "\n")
  cat("`quarter(dto)`: ", quarter(dto), "\n")
  cat("`week(dto)`: ", week(dto), "\n")
  cat("`isoweek(dto)`: ", isoweek(dto), "\n")
  cat("`epiweek(dto)`: ", epiweek(dto), "\n")
  cat("`wday(dto)`: ", wday(dto), "\n")
  cat("`qday(dto)`: ", qday(dto), "\n")
  cat("`yday(dto)`: ", yday(dto), "\n")
  cat("`am(dto)`: ", am(dto), "\n")
  cat("`pm(dto)`: ", pm(dto), "\n")
  cat("`days_in_month(dto)`: ", days_in_month(dto), "\n")
  cat("`dst(dto)`: ", dst(dto), "\n")
  cat("`leap_year(dto)`: ", leap_year(dto), "\n")
}
#> `isoyear(dto)`:  2025 
#> `epiyear(dto)`:  2025 
#> `semester(dto)`:  1 
#> `quarter(dto)`:  1 
#> `week(dto)`:  12 
#> `isoweek(dto)`:  13 
#> `epiweek(dto)`:  13 
#> `wday(dto)`:  2 
#> `qday(dto)`:  83 
#> `yday(dto)`:  83 
#> `am(dto)`:  TRUE 
#> `pm(dto)`:  FALSE 
#> `days_in_month(dto)`:  31 
#> `dst(dto)`:  TRUE 
#> `leap_year(dto)`:  FALSE