opts_yearqtr: Constructive options for class 'yearqtr'

View source: R/s3-yearqtr.R

opts_yearqtrR Documentation

Constructive options for class 'yearqtr'

Description

These options will be used on objects of class 'yearqtr'.

Usage

opts_yearqtr(constructor = c("as.yearqtr", "yearqtr", "next"), ...)

Arguments

constructor

String. Name of the function used to construct the object.

...

Additional options used by user defined constructors through the opts object

Details

Depending on constructor, we construct the object as follows:

  • "as.yearqtr" (default): We build the object using zoo::as.yearqtr() on a string in the format "2000 Q3".

  • "yearqtr" : We build the object using zoo::yearqtr() on a double in the format 2000.5

  • "next" : Use the constructor for the next supported class.

Value

An object of class <constructive_options/constructive_options_yearqtr>


constructive documentation built on April 3, 2025, 9:39 p.m.