DSTimeSeriesDateRange {DatastreamR}

DSTimeSeriesDateRange

Description

This class is a supporting attribute for the DateRange property of the DSTimeSeriesResponseObject. It returns the raw data for the timeseries. The DateRange property of the DSTimeSeriesResponseObject always returns the dates for a given frequency as the first date in each period. (e.g. 2022-01-01, 2020-04-01, etc. for quarterly frequencies). You specify whether you want your users to receive either the first, mid or end dates in the given period by setting the DateAlignment property (DSTimeSeriesDateAlignment) of the DSTimeSeriesRequestObject.

When you retrieve a list of all your available timeseries using the GetAllItems method, since this list could contain many thousand timeseries objects, the Dates and Values lists will always be NULL. Only the ValuesCount field will be set to reflect the number of datapoints available for each item. You need to request an individual timeseries (GetItem method) in order to receive a response containing actual data in the Dates and Values properties.

Value

DSTimeSeriesDateRange object

Public fields

Dates

• A list of datetime values specifying the dates for each datapoint.

Values

• A list of float values specifying the values for each datapoint.

ValuesCount

• A count of the number of datapoints in the timeseries.

Methods

Public methods

• DSTimeSeriesDateRange$new()

• DSTimeSeriesDateRange$clone()

Method new()

Usage

DSTimeSeriesDateRange$new(jsonDict, convertNullToNans = FALSE)

Arguments

jsonDict

JSON dictionary (from JSON Response)

convertNullToNans

FALSE by default, TRUE converts the NULLs in the NaNs (Not a Number)

Returns

DSTimeSeriesDateRange object

Method clone()

The objects of this class are cloneable with this method.

Usage

DSTimeSeriesDateRange$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.