SeriesExpression class

Description

Information about series in a unified series request.

Objects from the Class

You create an instance through a call to addSeries. The default values of the properties are:

Methods

getMissingValueMethod

signature(m = "SeriesExpression"): Get the method used for filling in any missing values. It will be one of the values in the list TimeSeriesMissingValueMethod.

setMissingValueMethod

signature(m = "SeriesExpression", method = "TimeSeriesMissingValueMethodClass"): Set the method used for filling in missing values. It should be one of the values in the list TimeSeriesMissingValueMethod.

setMissingValueMethod

signature(m = "SeriesExpression", method = "character"): Set the method used for filling in missing values. It should be one of the names of the list TimeSeriesMissingValueMethod.

getName

signature(object = "SeriesExpression"): Get the name of the series.

setName

signature(object = "SeriesExpression", name = "character"): Set the name of the series.

getToHigherFrequencyMethod

signature(m = "SeriesExpression"): Get the method used for converting to a higher frequency. It will be one of the values in the list TimeSeriesToHigherFrequencyMethod.

setToHigherFrequencyMethod

signature(m = "SeriesExpression", method = "TimeSeriesToHigherFrequencyMethodClass"): Set the method used for converting to a higher frequency. It should be one of the values in the list TimeSeriesToHigherFrequencyMethod.

setToHigherFrequencyMethod

signature(m = "SeriesExpression", method = "character"): Set the method used for converting to a higher frequency. It will be be one of the names of the list TimeSeriesToHigherFrequencyMethod.

getToLowerFrequencyMethod

signature(m = "SeriesExpression"): Get the method used for converting to a lower frequency. It will be one of the values in the list TimeSeriesToLowerFrequencyMethod.

setToLowerFrequencyMethod

signature(m = "SeriesExpression", method = "TimeSeriesToLowerFrequencyMethodClass"): Set the method used for converting to a lower frequency. It should be one of the values in the list TimeSeriesToLowerFrequencyMethod.

setToLowerFrequencyMethod

signature(m = "SeriesExpression", method = "character"): Set the method used for converting to a lower frequency. It will be one of the names of the list TimeSeriesToLowerFrequencyMethod.

getPartialPeriodsMethod

signature(m = "SeriesExpression"): Get the method used for converting partial periods to a lower frequency. It will be one of the values in the list TimeSeriesPartialPeriodsMethod. Introduced in MB 1.21.

setPartialPeriodsMethod

signature(m = "SeriesExpression", method = "TimeSeriesPartialPeriodsMethodClass"): Set the method used for converting partial periods to a lower frequency. It should be one of the values in the list TimeSeriesPartialPeriodsMethod. Introduced in MB 1.21.

setPartialPeriodsMethod

signature(m = "SeriesExpression", method = "character"): Set the method used for converting partial periods to a lower frequency. It will be one of the names of the list TimeSeriesPartialPeriodsMethod. Introduced in MB 1.21.

show

signature(object = "SeriesExpression"): Show a summary of the time series expression.

See Also

SeriesRequest addSeries CreateUnifiedTimeSeriesRequest FetchTimeSeries

Examples

seriesRequest <- CreateUnifiedTimeSeriesRequest()
setFrequency(seriesRequest, "Monthly")
addSeries(seriesRequest, "usgdp")
seriesExpressionCpi <- addSeries(seriesRequest, "uscpi")
setMissingValueMethod(seriesExpressionCpi, "None")
twoSeries <- FetchTimeSeries(seriesRequest)