show_lsm: Show landscape metrics

View source: R/show_lsm.R

show_lsmR Documentation

Show landscape metrics

Description

Show landscape metrics on patch level printed in their corresponding patch.

Usage

show_lsm(
  landscape,
  what,
  class = "global",
  directions = 8,
  consider_boundary = FALSE,
  edge_depth = 1,
  labels = FALSE,
  label_lsm = FALSE,
  nrow = NULL,
  ncol = NULL
)

Arguments

landscape

*Raster object

what

Patch level what to plot

class

How to show the labeled patches: "global" (single map), "all" (every class as facet), or a vector with the specific classes one wants to show (every selected class as facet).

directions

The number of directions in which patches should be connected: 4 (rook's case) or 8 (queen's case).

consider_boundary

Logical if cells that only neighbour the landscape boundary should be considered as core

edge_depth

Distance (in cells) a cell has the be away from the patch edge to be considered as core cell

labels

Logical flag indicating whether to print or not to print patch labels.

label_lsm

If true, the value of the landscape metric is used as label

nrow, ncol

Number of rows and columns for the facet.

Details

The function plots all patches with a fill corresponding to the value of the chosen landscape metric on patch level.

For all metrics based on distances or areas please make sure your data is valid using check_landscape.

Value

ggplot

Examples

landscape <- terra::rast(landscapemetrics::landscape)

show_lsm(landscape, what = "lsm_p_area", directions = 4)
show_lsm(landscape, what = "lsm_p_shape", class = c(1, 2), label_lsm = TRUE)
show_lsm(landscape, what = "lsm_p_circle", class = 3, labels = TRUE)


landscapemetrics documentation built on Sept. 12, 2024, 7:42 a.m.