datarobot (version 2.8.0)

DownloadReasonCodes: Function to download and save reason codes rows as csv file

Description

Function to download and save reason codes rows as csv file

Usage

DownloadReasonCodes(project, reasonCodeId, filename, encoding = "UTF-8",
  excludeAdjustedPredictions = TRUE)

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.

reasonCodeId

character. id of the reason codes.

filename

character. Fileneme of file to save reason codes rows

encoding

character. Optional. Character string A string representing the encoding to use in the output file, defaults to 'UTF-8'.

excludeAdjustedPredictions

logical. Optional. Set to FALSE to include adjusted predictions, which are predictions adjusted by an exposure column. This is only relevant for projects that use an exposure column.

Value

Logical TRUE and displays a message to the user if the delete request was successful; otherwise an error message is displayed.

Examples

# NOT RUN {
  projectId <- "59a5af20c80891534e3c2bde"
  modelId <- "5996f820af07fc605e81ead4"
  datasets <- ListPredictionDatasets(projectId)
  dataset <- datasets[[1]]
  datasetId <- dataset$id
  model <- GetModel(model, datasetId)
  jobId <- RequestReasonCodes(model, datasetId)
  reasonCodeId <- GetReasonCodesMetadataFromJobId(projectId, jobId)
  file <- file.path(tempdir(), "testReasonCode.csv")
  DownloadReasonCodes(projectId, reasonCodeId, file)
# }