datarobot (version 2.18.6)

CreateComplianceDocumentation: Create compliance documentation from a model.

Description

Note that if you're looking to download compliance documentation to a DOCX file, you can call DownloadComplianceDocumentation directly without using this function.

Usage

CreateComplianceDocumentation(model, templateId = NULL)

Value

An integer value that can be used as the jobId parameter in a subsequent call to WaitForJobToComplete.

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.

templateId

character. Optional. The ID of the template to use in generating custom model documentation.

Examples

if (FALSE) {
  projectId <- "59a5af20c80891534e3c2bde"
  modelId <- "5996f820af07fc605e81ead4"
  model <- GetModel(projectId, modelId)
  jobId <- CreateComplianceDocumentation(model) # optional step
  WaitForJobToComplete(projectId, jobId)        # optional step
  DownloadComplianceDocumentation(model)
}