summary_spotoroo: Summarizing spatiotemporal clustering results

View source: R/summary_spotoroo.R

summary_spotorooR Documentation

Summarizing spatiotemporal clustering results

Description

This function takes a spotoroo object to produce a summary of the clustering results. It can be called by summary.spotoroo().

Usage

summary_spotoroo(result, cluster = "all")

Arguments

result

spotoroo object. A result of a call to hotspot_cluster().

cluster

Character/Integer. If "all", summarize all clusters. If an integer vector is given, summarize corresponding clusters.

Value

No return value, called for side effects

Examples



  # Time consuming functions (>5 seconds)


  # Get clustering results
  result <- hotspot_cluster(hotspots,
                           lon = "lon",
                           lat = "lat",
                           obsTime = "obsTime",
                           activeTime = 24,
                           adjDist = 3000,
                           minPts = 4,
                           minTime = 3,
                           ignitionCenter = "mean",
                           timeUnit = "h",
                           timeStep = 1)


  # Make a summary of all clusters
  summary_spotoroo(result)

  # Make a summary of cluster 1 to 3
  summary_spotoroo(result, 1:3)



spotoroo documentation built on Aug. 21, 2023, 9:10 a.m.