DownloadComplianceDocumentation: Download compliance documentation (in DOCX format).

Description Usage Arguments Value Examples

View source: R/ComplianceDocumentation.R

Description

This function will create the compliance documentation first if it has not already been created. To create compliance documentation without downloading it, use CreateComplianceDocumentation. You can then skip the create step in this function by using 'create = FALSE'.

Usage

1
2
3
4
5
6
7
DownloadComplianceDocumentation(
  model,
  filename,
  templateId = NULL,
  create = TRUE,
  maxWait = 600
)

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.

filename

character. Filename of file to save the compliance documentation to.

templateId

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

create

logical. Should we create the compliance documentation prior to downloading?

maxWait

integer. How long to wait (in seconds) for compliance documentation creation before raising a timeout error? Default 600.

Value

Nothing returned, but downloads the file to the stated filename.

Examples

1
2
3
4
5
6
7
## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  modelId <- "5996f820af07fc605e81ead4"
  model <- GetModel(projectId, modelId)
  DownloadComplianceDocumentation(model)

## End(Not run)

datarobot documentation built on June 2, 2021, 9:06 a.m.