DSTimeSeriesDataInput: DSTimeSeriesDataInput

In DatastreamR: Datastream API

DSTimeSeriesDataInput

Description

This class is a supporting attribute for the DateInput property of the DSTimeSeriesRequestObject. It is used to supply the raw data for the timeseries.

Value

DSTimeSeriesDataInput object

Public fields

StartDate

A datetime value defining the start date for the timeseries.

EndDate

A datetime value defining the end date for the timeseries.

Frequency

The frequency of the timeseries. One of the DSUserObjectFrequency values defined in DSUserDataObjectBase.R

Values

An array of float values. Use NULL to represent NotANumber for non-trading days. Alternatively, if you set the DatastreamUserCreated_TimeSeries property useNaNforNotANumber as True, you can use float NaN values.

Methods

Public methods

• DSTimeSeriesDataInput$new()

• DSTimeSeriesDataInput$clone()

---

Method new()

Usage

DSTimeSeriesDataInput$new(
  startDate = NULL,
  endDate = NULL,
  frequency = DSUserObjectFrequency$Daily,
  values = NULL
)

Arguments

startDate

A datetime value defining the start date for the timeseries.

endDate

A datetime value defining the end date for the timeseries.

frequency

The frequency of the timeseries.

values

An array of float values

Returns

DSTimeSeriesDataInput object

---

Method clone()

The objects of this class are cloneable with this method.

Usage

DSTimeSeriesDataInput$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Note

Datastream takes the StartDate, Frequency and Values properties defined here and creates the timeseries based only on these parameters.The EndDate is not actually used internally other than for logging purposes. The true end date is calculated based on the start date, frequency and the supplied list of values. Supply too few or too many values and the mainframe will accept them and set the end date accordingly based on the given frequency for the item.

DatastreamR documentation built on May 29, 2024, 12:05 p.m.