R/Drivers.R

In datarobot: 'DataRobot' Predictive Modeling API

#' Returns a dataframe with information on available drivers.
#'
#' @return data.frame containing information on possible drivers.
#' @examples
#' \dontrun{
#'  ListDrivers()
#' }
#' @export
ListDrivers <- function() {
  routeString <- UrlJoin("externalDataDrivers")
  drivers <- DataRobotGET(routeString)
  drivers <- GetServerDataInRows(drivers)
  as.dataRobotDrivers(drivers)
}

as.dataRobotDrivers <- function(elements) {
  elements[, c("id", "canonicalName", "className", "baseNames", "creator")]
}


#' Returns information about a particular driver.
#'
#' @param driverId character. The id of the driver.
#' @return A list containing information on the particular driver:
#' \itemize{
#'   \item className character. The Java class name of the driver.
#'   \item baseNames character. A vector of the file name(s) of the jar files.
#'   \item canonicalName character. The user-friendly name of the driver.
#'   \item id character. The driverId of the driver.
#'   \item creator character. The userId of the user who created the driver.
#' }
#' @examples
#' \dontrun{
#'  driverId <- "57a7c978c808916f4a630f89"
#'  GetDriver(driverId)
#' }
#' @export
GetDriver <- function(driverId) {
  routeString <- UrlJoin("externalDataDrivers", driverId)
  driver <- DataRobotGET(routeString)
  as.dataRobotDriver(driver)
}

as.dataRobotDriver <- function(inList) {
  elements <- c("id", "canonicalName", "className", "baseNames", "creator")
  outList <- ApplySchema(inList, elements)
  class(outList) <- "dataRobotDriver"
  outList
}