R/discords.R

In franzbischoff/tsmp: Time Series with Matrix Profile

#' Search for Discord
#'
#' @param profile a `MatrixProfile` or `PMP` object.
#' @param exclusion_zone an `int`. Number of values to exclude on both sides of the motif to avoid trivial matches.
#' Defaults to the exclusion zone used to compute the (Pan-)Matrix Profile which is found in the profile data structure.
#' @param k an `int`. Number of discords to find. (Default is `3`).
#' @param neighbor_count an `int`. Number of neighbors to find. (Default is `3`).
#' @param radius an `int`. Set a threshold to exclude matching neighbors with distance > current
#' discord distance * `radius`. (Default is `3`).
#'
#' @name discords
#' @export
#' @references Website: <http://www.cs.ucr.edu/~eamonn/MatrixProfile.html>
#' @family Main API

discords <- function(profile, exclusion_zone = profile$ez, k = 3L, neighbor_count = 10L, radius = 3) {
  find_discord(profile, n_discords = k, n_neighbors = neighbor_count, radius = radius, exclusion_zone = exclusion_zone)
}