UCTSUpload {DatastreamDSWS2R} | R Documentation |
Upload a UCTS timeseries into Datastream
Description
Uploads an xts into a UCTS in the Datastream Database
Usage
UCTSUpload(
tsData,
TSCode = "",
MGMTGroup = "ABC",
freq = c("D", "W", "M", "Q", "Y"),
seriesName,
Units = "",
Decimals = 2,
ActPer = c("N", "Y"),
freqConversion = c("ACT", "SUM", "AVG", "END"),
Alignment = c("1ST", "MID", "END"),
Carry = c("YES", "NO", "PAD"),
PrimeCurr = "",
strUsername = ifelse(Sys.getenv("DatastreamUsername") != "",
Sys.getenv("DatastreamUsername"), options()$Datastream.Username),
strPassword = ifelse(Sys.getenv("DatastreamPassword") != "",
Sys.getenv("DatastreamPassword"), options()$Datastream.Password),
strServerName = "https://product.datastream.com",
strServerPage = "/UCTS/UCTSMaint.asp"
)
Arguments
tsData |
- an xts (or timeseries object that can be converted to one) to be uploaded. |
TSCode |
The mnemonic of the target UCTS |
MGMTGroup |
Must have managment group. Only the first characters will be used. |
freq |
The frequency of the data to be uploaded |
seriesName |
the name of the series |
Units |
Units of the data - can be no more than 12 characters - excess will be trimmed to that length |
Decimals |
Number of Decimals in the data - a number between 0 and 9 - if outside that range then trimmed |
ActPer |
Whether the values are percentages ("N") or actual numbers ("Y") |
freqConversion |
How to do any FX conversions |
Alignment |
Alignment of the data within periods |
Carry |
whether to carry data over missing dates |
PrimeCurr |
the currency of the timeseries |
strUsername |
your Datastream username |
strPassword |
your Datastream Password |
strServerName |
URL of the Datastream server |
strServerPage |
page on the datastream server |
Details
Note this function does not check to see if there is a pre-existing timeseries already in Datastream. It will just overwrite any existing UCTS.
Value
TRUE if the upload has been a success, otherwise an error message