show_correlation {landscapemetrics}

Show correlation

Description

Show correlation

Usage

show_correlation(
  data,
  method = "pearson",
  diag = TRUE,
  labels = FALSE,
  vjust = 0,
  text_size = 15
)

Arguments

data

Tibble with results of as returned by the landscapemetrics package.

method

Type of correlation. See link{cor} for details.

diag

If FALSE, values on the diagonal will be NA and not plotted.

labels

If TRUE, the correlation value will be added as text.

vjust

Will be passed on to ggplot2 as vertical justification of x-axis text.

text_size

Text size of the plot.

Details

The functions calculates the correlation between all metrics. In order to calculate correlations, for the landscape level more than one landscape needs to be present. All input must be structured as returned by the landscapemetrics package.

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)

metrics <- calculate_lsm(landscape, what = c("patch", "class"))
show_correlation(data = metrics, method = "pearson")

## Not run: 
metrics <- calculate_lsm(landscape, what = c("patch", "class"))
correlations <- calculate_correlation(metrics)
show_correlation(data = correlations, method = "pearson")

## End(Not run)