datarobot (version 2.18.6)

GetComplianceDocTemplate: Get a compliance doc template.

Description

A custom compliance doc template can be retrieved using templateId. Default compliance doc templates that are built-in to DataRobot can be retrieved by using the type parameter. A type of NULL or "normal" will retrieve the default template. A type of "timeSeries" can be used to retrieve the default time series template.

Usage

GetComplianceDocTemplate(templateId = NULL, type = NULL)

Value

An S3 object of class 'dataRobotComplianceDocTemplate' that contains:

• name character. The name of the compliance doc template.

• creatorUsername character. The name of the user who created the compliance doc template.

• orgId character. The ID of the organization of the creator user.

• creatorId character. The ID of the creator user.

• sections list. The list of sections that define the template.

• id character. The ID of the template.

Arguments

templateId

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

type

character. Optional. The type of compliance doc to get. Can be "normal" to retrieve the default template or "timeSeries" to get the default time series template.

Examples

if (FALSE) {
  GetComplianceDocTemplate()  # get the default template
  GetComplianceDocTemplate(type = "normal")  # get the default template
  GetComplianceDocTemplate(type = "timeSeries")  # get the default time series template
  templateId <- "5cf85080d9436e5c310c796d"
  GetComplianceDocTemplate(templateId) # Get a custom template for a specific ID.
}