GetAccuracyOverTimePlotsMetadata: Retrieve Accuracy over Time plots metadata for a model.

In datarobot: 'DataRobot' Predictive Modeling API

Retrieve Accuracy over Time plots metadata for a model.

Description

Retrieve Accuracy over Time plots metadata for a model.

Usage

GetAccuracyOverTimePlotsMetadata(model, forecastDistance = NULL)

Arguments

model	An S3 object of class dataRobotModel like that returned by the function GetModel, or each element of the list returned by the function ListModels.
forecastDistance	integer. Optional. Forecast distance to retrieve the metadata for. If not specified, the first forecast distance for this project will be used. Only available for time series projects.

Value

list with the following components:

• forecastDistance. integer or NULL: The forecast distance for which the metadata was retrieved. NULL for OTV projects.

• resolutions. list: A list of DatetimeTrendPlotsResolutions, which represents available time resolutions for which plots can be retrieved.

• backtestStatuses. data.frame: Each row represents a status for the backtest SourceType. The row index corresponds to the backtest index via the relation rowIndex <- backtestIndex + 1. Status should be one of DatetimeTrendPlotsStatuses

• backtestMetadata. data.frame: Each row represents a metadata for the backtest SourceType start and end date. The row index corresponds to the backtest index via the relation rowIndex <- backtestIndex + 1. Each cell contains a POSIXct timestamp for start date (inclusive) and end date (exclusive) if the correspoding source type for the backtest is computed, and NA otherwise.

• holdoutStatuses. list: Contains statuses for holdout.

  • training. character: Status, one of DatetimeTrendPlotsStatuses

  • validation. character: Status, one of DatetimeTrendPlotsStatuses

• holdoutMetadata. list. Contains metadata for holdout.

  • training. list. Contains start and end date for holdout training.

  • validation. list. Contains start and end date for holdout validation.

    • startDate. POSIXct or NA: The datetime of the start of the holdout training/validation (inclusive). NA if the data is not computed.

    • endDate. POSIXct or NA: The datetime of the end of the holdout training/validation (exclusive). NA if the data is not computed.

Examples

## Not run: 
projectId <- "59a5af20c80891534e3c2bde"
modelId <- "5996f820af07fc605e81ead4"
model <- GetModel(projectId, modelId)
GetAccuracyOverTimePlotsMetadata(model)

## End(Not run)

datarobot documentation built on May 29, 2024, 4:36 a.m.