datarobot (version 2.14.2)

GetMultiSeriesProperties: Retrieve time series properties for a potential multiseries datetime partition column

Description

Multiseries time series projects use multiseries id columns to model multiple distinct series within a single project. This function returns the time series properties (time step and time unit) of this column if it were used as a datetime partition column with the specified multiseries id columns, running multiseries detection automatically if it had not previously been successfully ran.

Usage

GetMultiSeriesProperties(project, dateColumn, multiseriesIdColumns,
  maxWait = 600)

Arguments

project

character. Either (1) a character string giving the unique alphanumeric identifier for the project, or (2) a list containing the element projectId with this identifier.

dateColumn

character. The name of the column containing the date that defines the time series.

multiseriesIdColumns

list. The name(s) of the multiseries id columns to use with this datetime partition column. Currently only one multiseries id column is supported.

maxWait

integer. if a multiseries detection task is run, the maximum amount of time to wait for it to complete before giving up.

Value

A named list which contains:

• time_series_eligible logical. Whether or not the series is eligible to be used for time series.

• timeUnit character. For time series eligible features, the time unit covered by a single time step, e.g. "HOUR", or NULL for features that are not time series eligible.

• timeStep integer Expected difference in time units between rows in the data.

Examples

# NOT RUN {
  projectId <- "59a5af20c80891534e3c2bde"
  GetMultiSeriesProperties(projectId,
                           dateColumn = "myFeature",
                           multiseriesIdColumns = "Store")
# }