Learn R Programming

datarobot (version 2.18.6)

as.dataRobotMultiSeriesProperties: Return value for GetMultiSeriesProperties() and others

Description

Return value for GetMultiSeriesProperties() and others

Usage

as.dataRobotMultiSeriesProperties(inList)

Value

A named list which contains:

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

  • crossSeriesEligible logical. Whether or not the cross series group by column is eligible for cross-series modeling. Will be NULL if no cross series group by column is used.

  • crossSeriesEligibilityReason character. The type of cross series eligibility (or ineligibility).

  • 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. Will be NULL for features that are not time series eligible.

Arguments

inList

list. See return value below for expected elements.

See Also

Other MultiSeriesProject functions: GetMultiSeriesProperties(), RequestCrossSeriesDetection(), RequestMultiSeriesDetection()