Skip to contents

Plot map of dual kernel-density values

Source: R/autoplot.R, R/hotspot_map.R
autoplot.hspt_dk.Rd

Plot the output produced by hotspot_dual_kde() using a scale appropriate to the comparison method. Ratios, logged ratios and sums use sequential scales. Only differences use a diverging scale centred on zero. Legends label the lower and upper ends of each scale as "low" and "high", respectively.

Usage

# S3 method for class 'hspt_dk'
autoplot(
  object,
  ...,
  basemap_type = "none",
  basemap_zoom = NULL,
  basemap_attribution = NULL,
  quiet = TRUE
)

# S3 method for class 'hspt_dk'
autolayer(object, ...)

# S3 method for class 'hspt_dk'
hotspot_map(
  object,
  mapping = NULL,
  ...,
  basemap_type = "osm",
  basemap_zoom = NULL,
  basemap_attribution = NULL,
  caption = NULL,
  quiet = TRUE
)

Arguments

object

An object with class hspt_dk, e.g. as produced by hotspot_dual_kde(). The object must have a valid method attribute.

...

Further arguments passed to ggplot2::geom_sf(), e.g. alpha.

basemap_type

A map type passed to the type argument of ggspatial::annotation_map_tile(), or "none" for no base map. autoplot() defaults to "none" and hotspot_map() defaults to "osm". A base map requires an internet connection unless the required tiles are cached. When a base map is used, the hotspot layer is drawn with alpha = 0.75, overriding any alpha value supplied in ....

basemap_zoom

The zoom level passed to ggspatial::annotation_map_tile(), or NULL to choose it automatically.

basemap_attribution

Attribution for the tile provider, or NULL to use the statement known for basemap_type. A non-empty string is required for a custom or otherwise unknown map type.

quiet

If TRUE (the default), suppress progress bars and other messages. If FALSE, show tile-download progress and other messages.

mapping

For hotspot_map(), this must be NULL. Hotspot-result objects determine their own aesthetic mappings.

caption

For hotspot_map(), additional text to display in the map caption, or NULL for no additional text. Base-map attribution and any explanatory caption generated by the plotting method are retained, with explanatory text above this caption and attribution below it.

Value

autoplot() and hotspot_map() return ggplot2::ggplot objects. autolayer() returns a layer that can be added to a ggplot2::ggplot object.

Functions

  • autolayer(hspt_dk): Create a ggplot layer of dual density values.

  • hotspot_map(hspt_dk): Create an automatic map of dual density values.