ListPredictionDatasets: Retrieve all prediction datasets associated with a project

View source: R/PredictionDatasets.R

ListPredictionDatasetsR Documentation

Retrieve all prediction datasets associated with a project

Description

This function returns an S3 object of class listDataRobotPredictionDataset that describes all prediction datasets available for the project specified by the project parameter. This list may be converted to a dataframe with the as.data.frame method for objects of class listDataRobotPredictionDataset.

Usage

ListPredictionDatasets(project)

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.

Value

An S3 object of class 'listDataRobotPredictionDataset', which is a list of dataframes: each element of the list corresponds to one prediction dataset associated with the project, and each dataframe has one row and the following columns:

  • id character. The unique alphanumeric identifier for the dataset.

  • numColumns numeric. Number of columns in dataset.

  • name character. Name of dataset file.

  • created character. time of upload.

  • projectId character. String giving the unique alphanumeric identifier for the project.

  • numRows numeric. Number of rows in dataset.

  • forecastPoint. The point relative to which predictions will be generated, based on the forecast window of the project. Only specified in time series projects, otherwise will be NULL.

Examples

## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  ListPredictionDatasets(projectId)

## End(Not run)

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