grates (version 1.4.3)

year_class: Year class

Description

Years are represented by a <grates_year> object.

Usage

year(x = integer())
as_year(x, ...)
# S3 method for default
as_year(x, ...)
# S3 method for Date
as_year(x, ...)
# S3 method for POSIXt
as_year(x, ...)
# S3 method for character
as_year(x, ...)
# S3 method for factor
as_year(x, ...)
is_year(object)

Value

A <grates_year> object.

Arguments

x, object

R objects.

...

Only used For character input where additional arguments are passed through to as.Date().

Details

year() takes as input a vector representing, unsurprisingly, the years. double vectors are coerced via as.integer(floor(x)).

as_yearquarter() is a generic for coercing input in to <grates_year>.

• Character input is first parsed using as.Date().

• POSIXct and POSIXlt are converted with their timezone respected.

Examples

# date coercion
as_year(Sys.Date())

# POSIXt coercion
as_year(as.POSIXct("2019-03-04 01:01:01", tz = "America/New_York"))

# Character coercion
as_year("2019-05-03")

# direct construction
year(2011:2020)