R/extract.clusters.R

In jpfrench81/smacpod: Statistical Methods for the Analysis of Case-Control Point Data

#' Extract clusters
#'
#' @param x An object of class \code{spscan} from the \code{\link{spscan.test}}
#'
#' @return A list. Each element of the list is a vector with the indices of event
#' locations in the associated cluster.
#' @export
#' @examples
#' data(grave)
#' # apply scan method
#' out = spscan.test(grave, nsim = 99)
#' # print scan object
#' clusters(out)
#' @method clusters spscan
#' @inheritParams smerc::clusters
#' @export
clusters.spscan = function(x, idx = seq_along(x$clusters), ...) {
  if (min(idx) < 1 | max(idx) > length(x$clusters)) {
    stop("invalid idx values")
  }
  smerc::lget(x$clusters[idx], "locids")
}

#' @importFrom smerc clusters
#' @export
smerc::clusters