DSTimeSeriesUserObjectBase {DatastreamR}R Documentation

DSTimeSeriesUserObjectBase

Description

This is the base object for creating or requesting timeseries data. It has two subclasses DSTimeSeriesRequestObject and DSTimeSeriesResponseObject. It defines the basic attributes for a timeseries. It subclasses DSUserObjectBase which defines the basic attributes common to all five user created item types supported by the API.

Specifics of some of the properties of the DSUserObjectBase superclass
———————————————————————-
ID
The ID property is defined in DSUserObjectBase but has a specific format for timeseries. Timeseries IDs must be 8 alphanumeric characters long, start with TS followed by 6 uppercase alphanumeric characters. For example: TSTEST01, TS123456, TSMYTEST, etc.
Mnemonic
The Mnemonic property is defined in DSUserObjectBase but should always be left empty or set the same as the ID property for timeseries requests. As a safety measure, this class always ensures it's the same as the ID. In a response from the API server, the value will always be the same as the ID.
(see DSUserObjectBase for a description of the other properties)

DSTimeSeriesUserObjectBase specific properties

Value

DSTimeSeriesUserObjectBase object

Super class

DatastreamR::DSUserObjectBase -> DSTimeSeriesUserObjectBase

Public fields

ManagementGroup

This is an optional group name that allows you to organise timeseries into distinct 'folders' displayed in the search category of Navigator. This can be up to 10 uppercase alphanumeric characters. Leave blank for the item to be assigned under the 'GENERAL' group.

Units

This is a optional qualifying unit for your data. For example: tons, U$ millions, index, etc. Maximum 12 characters.

DecimalPlaces

A numeric value between 0 and 8 decimal places specifying how many decimal places to use when storing data. The maximum length including decimals for a value is 10 characters including the decimal point. Boundary case examples are 0.12345678, 1234567890, 123456789.0, etc.

FrequencyConversion

A DSTimeSeriesFrequencyConversion enum value specifying how to return values if a user requests data at a lower frequency than the timeseries data is supplied. See DSTimeSeriesFrequencyConversion for details.

DateAlignment

A DSTimeSeriesDateAlignment enum value specifying whether dates for certain frequencies should be returned as the start, middle or end date of the period. See DSTimeSeriesDateAlignment for details.

CarryIndicator

A DSTimeSeriesCarryIndicator enum value specifying how to treat 'Not A Number' values for non-trading days and how to represent values if users request data after the end of the timeseries range. See DSTimeSeriesCarryIndicator for details.

PrimeCurrencyCode

An optional 2 character currency code for your timeseries.

HasPadding

This property has been replaced with the CarryIndicator property and will always be False

UnderCurrencyCode

This property has been deprecated and will always return NULL

AsPercentage

This This property has been deprecated and will always return False

Methods

Public methods

Inherited methods

Method new()

Usage
DSTimeSeriesUserObjectBase$new(jsonDict)
Arguments
jsonDict

JSON dictionary (from JSON Response)

Returns

DSTimeSeriesUserObjectBase object

Method clone()

The objects of this class are cloneable with this method.

Usage
DSTimeSeriesUserObjectBase$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

[Package DatastreamR version 2.0.4 Index]