DSTimeSeriesDateInfo {DatastreamR}R Documentation

DSTimeSeriesDateInfo

Description

This class is a supporting attribute for the DateInfo property of the DSTimeSeriesResponseObject. It describes the basic range of data for the timeseries.

The DateRange property (DSTimeSeriesDateRange described above) 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). However, The StartDate and EndDate values returned in this class for the DSTimeSeriesResponseObject reflect the start and end dates of the range of dates that would be returned to users requesting the data via Datastream For Office, charting, etc. This depends on the DateAlignment property (DSTimeSeriesDateAlignment) of the timeseries. The start and end dates returned here will be either the start, mid or end dates for the set frequency based on the DateAlignment property (see DSTimeSeriesDateAlignment).

Value

DSTimeSeriesDateInfo object

Public fields

StartDate

A datetime value defining the start date of the timeseries data

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

Methods

Public methods


Method new()

Usage
DSTimeSeriesDateInfo$new(jsonDict)
Arguments
jsonDict

JSON dictionary (from JSON Response)

Returns

DSTimeSeriesDateInfo object


Method clone()

The objects of this class are cloneable with this method.

Usage
DSTimeSeriesDateInfo$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


[Package DatastreamR version 2.0.4 Index]