datarobot (version 2.18.6)

UploadComplianceDocTemplate: Upload a compliance doc template.

Description

The structure of the compliance doc template can be specified by either a file specified by filename or by specifying it with a list via sections.

Usage

UploadComplianceDocTemplate(name, filename = NULL, sections = NULL)

Value

Nothing returned, but uploads the compliance doc template.

Arguments

name

character. A name to identify the compliance doc template by.

filename

character. Optional. Filename of file to save the compliance doc template to.

sections

list. Optional. Section definitions for the compliance template.

Examples

if (FALSE) {
 ## Create a compliance documentation template from uploading a file
 DownloadComplianceDocTemplate("template.json")
 # Edit template.json in your favorite editor
 UploadComplianceDocTemplate("myTemplate", "template.json")

## Create a compliance documentation template from a list.
sections <- list(list("title" = "Missing Values Report",
                      "highlightedText" = "NOTICE",
                      "regularText" = paste("This dataset had a lot of Missing Values.",
                                            "See the chart below: {{missingValues}}"),
                      "type" = "user"),
                 list("title" = "Blueprints",
                      "regularText" = "{{blueprintDiagram}} /n Blueprint for this model",
                      "type" = "user"))
}