accessors: Accessors

In tjtnew/grates: Grouped Date Classes

Description

Generics and methods to work with grouped date objects:

• get_week() returns the corresponding week values for a yrwk vector.

• get_year() returns the year.

• get_firstday() returns the firstday attribute of a yrwk object.

• get_month() returns the month.

Usage

get_week(x, ...)

## Default S3 method:
get_week(x, ...)

## S3 method for class 'yrwk'
get_week(x, ...)

get_month(x, ...)

## Default S3 method:
get_month(x, ...)

## S3 method for class 'yrmon'
get_month(x, style = c("numeric", "named"), ...)

get_quarter(x, ...)

## Default S3 method:
get_quarter(x, ...)

## S3 method for class 'yrqtr'
get_quarter(x, ...)

get_year(x, ...)

## Default S3 method:
get_year(x, ...)

## S3 method for class 'yrwk'
get_year(x, ...)

## S3 method for class 'yrmon'
get_year(x, ...)

## S3 method for class 'yrqtr'
get_year(x, ...)

get_firstday(x, ...)

## Default S3 method:
get_firstday(x, ...)

## S3 method for class 'yrwk'
get_firstday(x, ...)

get_interval(x, ...)

## Default S3 method:
get_interval(x, ...)

## S3 method for class 'period'
get_interval(x, days = FALSE, ...)

## S3 method for class 'yrwk'
get_interval(x, days = FALSE, ...)

## S3 method for class 'yrmon'
get_interval(x, days = FALSE, ...)

## S3 method for class 'yrqtr'
get_interval(x, days = FALSE, ...)

get_firstdate(x, ...)

## Default S3 method:
get_firstdate(x, ...)

## S3 method for class 'period'
get_firstdate(x, ...)

Arguments

x	A yrwk, yrmon, yrqtr or period object.
...	Not used.
style	Either "numeric" (default) for the integer month value or "named" to return the abbreviated month name in the current locale.
days	Should periods be converted in to a number of days.

Examples

x <- as_yrwk(Sys.Date())
get_year(x)
get_week(x)
get_firstday(x)

tjtnew/grates documentation built on Feb. 6, 2021, 6:12 p.m.