SetupProject: Function to set up a new DataRobot project

In datarobot: 'DataRobot' Predictive Modeling API

Function to set up a new DataRobot project

Description

This function uploads a modeling dataset defined by the dataSource parameter and allows specification of the optional project name projectName. The dataSource parameter can be either the name of a CSV file or a dataframe; in the latter case, it is saved as a CSV file whose name is described in the Details section. This function returns the projectName specified in the calling sequence, the unique alphanumeric identifier projectId for the new project, the name of the modeling dataset uploaded to create this project, and the project creation time and date.

Usage

SetupProject(dataSource, projectName = NULL, maxWait = 60 * 60)

Arguments

dataSource	object. Either (a) the name of a CSV file, (b) a dataframe or (c) url to a publicly available file; in each case, this parameter identifies the source of the data from which all project models will be built. See Details.
projectName	character. Optional. String specifying a project name.
maxWait	integer. The maximum time to wait for each of two steps: (1) The initial project creation request, and (2) data processing that occurs after receiving the response to this initial request.

Details

The DataRobot modeling engine requires a CSV file containing the data to be used in fitting models, and this has been implemented here in two ways. The first and simpler is to specify dataSource as the name of this CSV file, but for the convenience of those who wish to work with dataframes, this function also provides the option of specifying a dataframe, which is then written to a CSV file and uploaded to the DataRobot server. In this case, the file name is either specified directly by the user through the saveFile parameter, or indirectly from the name of the dataSource dataframe if saveFile = NULL (the default). In this second case, the file name consists of the name of the dataSource dataframe with the string csvExtension appended.

Value

A named list that contains:

projectName

character. The name assigned to the DataRobot project

projectId

character. The unique alphanumeric project identifier for this DataRobot project

fileName

character. The name of the CSV modeling file uploaded for this project

created

character. The time and date of project creation

Examples

## Not run: 
  SetupProject(iris, "dr-iris")

## End(Not run)

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