opts_xts: Constructive options for class 'xts'

View source: R/s3-xts.R

opts_xtsR Documentation

Constructive options for class 'xts'

Description

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

Usage

opts_xts(constructor = c("as.xts.matrix", "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.xts.matrix" (default): We build the object using xts::as.xts.matrix().

  • "as.xts.data.frame": We build the object using xts::as.xts.data.frame(), this is probably the most readable option but couldn't be made the default constructor because it requires the 'xts' package to be installed .

  • "xts": We build the object using xts::xts().

  • ".xts": We build the object using xts::.xts().

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

Value

An object of class <constructive_options/constructive_options_xts>


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