GetAnomalyAssessmentExplanations: Retrieve anomaly assessment explanations.

Description Usage Arguments Value See Also Examples

View source: R/AnomalyAssessment.R

Description

Explanations contain predictions along with shap explanations for the most anomalous records in the specified date range/for defined number of points. Two out of three parameters: startDate, endDate or pointsCount must be specified.

Usage

1
2
3
4
5
6
7
GetAnomalyAssessmentExplanations(
  projectId,
  recordId,
  startDate = NULL,
  endDate = NULL,
  pointsCount = NULL
)

Arguments

projectId

character. The ID of the project.

recordId

character. The ID of the anomaly assessment record.

startDate

POSIXct. Optional. The start of the date range to get explanations in.

endDate

POSIXct. Optional. The end of the date range to get explanations in.

pointsCount

integer. Optional. The number of the rows to return.

Value

The anomaly assessment explanations:

See Also

Other Anomaly Assessment functions: DeleteAnomalyAssessmentRecord(), GetAnomalyAssessmentPredictionsPreview(), InitializeAnomalyAssessment(), ListAnomalyAssessmentRecords()

Examples

1
2
3
4
5
6
7
## Not run: 
projectId <- "59a5af20c80891534e3c2bde"
recordId <- "59a5af20c80891534e3c2bdb"
explanations <- GetAnomalyAssessmentExplanations(projectId, recordId, pointsCount=100,
   startDate=as.Date("2021-01-01"))

## End(Not run)

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