metrics_list: Metrics list

View source: R/metrics_list.R

metrics_listR Documentation

Metrics list

Description

List of available landscape metrics provided by package landscapemetrics to be calculated with metrics(). It simply calls landscapemetrics::list_lsm(). For more information regarding the definition and equations of metrics, please check the user manual of landscapemetrics.

Usage

metrics_list(
  level = NULL,
  metric = NULL,
  name = NULL,
  type = NULL,
  what = NULL
)

Arguments

level

Character vector. Level of metrics. Either "patch", "class" or "landscape" (or a vector with a combination of these). Default NULL considers all levels.

metric

Abbreviation of metrics (e.g. "area").

name

Full name of metrics (e.g. "core area").

type

Character vector. Type according to FRAGSTATS grouping. One or more of the following: "area and edge", "core area", "shape", "aggregation", "complexity", and or "diversity". Default NULL considers all types.

what

Selected level of metrics: either "patch", "class" or "landscape". It is also possible to specify functions as a vector of strings, e.g. what = c("lsm_c_ca", "lsm_l_ta").

Value

A data.frame with the list of available landscape metrics, including information regarding the level, type, metric, name and function name provided by package landscapemetrics.

References

Hesselbarth, M.H.K., Sciaini, M., With, K.A., Wiegand, K., Nowosad, J. 2019. landscapemetrics: an open-source R tool to calculate landscape metrics. - Ecography 42:1648-1657(ver. 0).

McGarigal, K., SA Cushman, and E Ene. 2012. FRAGSTATS v4: Spatial Pattern Analysis Program for Categorical and Continuous Maps. Computer software program produced by the authors at the University of Massachusetts, Amherst. Available at the following web site: https://www.umass.edu/landeco/


phuais/multilandR documentation built on Feb. 11, 2024, 9:27 p.m.