---

output:
github_document:
html_preview: false

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

landscapemetrics

README last updated: r Sys.Date()

CI	Development	CRAN	License

Starting from v2.0.0, landscapemetrics uses terra and sf internally. More information about the terra package can be found here: https://rspatial.org/index.html.

Overview

landscapemetrics is a R package for calculating landscape metrics for categorical landscape patterns in a tidy workflow. The package can be used as a drop-in replacement for FRAGSTATS (McGarigal et al. 2023), as it offers a reproducible workflow for landscape analysis in a single environment. It also allows for calculations of four theoretical metrics of landscape complexity: a marginal entropy, a conditional entropy, a joint entropy, and a mutual information (Nowosad and Stepinski 2019).

landscapemetrics supports terra, and stars and takes SpatRaster or stars spatial objects as input arguments. Every function can be used in a piped workflow, as it always takes the data as the first argument and returns a tibble.

Citation

To cite landscapemetrics or acknowledge its use, please cite the following Software note, substituting the version of the application that you used for ‘v0.0’:

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 (v0.0).

For more information see Publication record vignette. The get a BibTex entry, please use citation("landscapemetrics").

Installation

There are several ways to install landscapemetrics:

# Get the stable version from CRAN
install.packages("landscapemetrics")

# Alternatively, you can install the development version from Github
# install.packages("remotes")
remotes::install_github("r-spatialecology/landscapemetrics")

Announcement

Due to an improved connected-component labelling algorithm (landscapemetrics v1.4 and higher), patches are labeled in a different order than before and therefore different patch IDs might be used compared to previous versions. However, results for all metrics are identical.

Using landscapemetrics

The resolution of a raster cell has to be in meters, as the package converts units internally and returns results in either meters, square meters or hectares. Before using landscapemetrics, be sure to check your raster (see check_landscape()).

All functions in landscapemetrics start with lsm_ (for landscape metrics). The second part of the name specifies the level (patch - p, class - c or landscape - l). The last part of the function name is the abbreviation of the corresponding metric (e.g. enn for the euclidean nearest-neighbor distance):

# general structure
lsm_"level"_"metric"

# Patch level
## lsm_p_"metric"
lsm_p_enn()

# Class level
## lsm_c_"metric"
lsm_c_enn()

# Landscape level
## lsm_p_"metric"
lsm_l_enn()

All functions return an identical structured tibble:

layer	level	class	id	metric	value
1	patch	1	1	landscape metric	x
1	class	1	NA	landscape metric	x
1	landscape	NA	NA	landscape metric	x

Using metric functions

Every function follows the same implementation design, so the usage is quite straightforward:

library(landscapemetrics)
library(terra)

# internal data needs to be read
landscape <- terra::rast(landscapemetrics::landscape)

# landscape raster
plot(landscape)

# calculate for example the Euclidean nearest-neighbor distance on patch level
lsm_p_enn(landscape)

# calculate the total area and total class edge length
lsm_l_ta(landscape)
lsm_c_te(landscape)

There is also a wrapper around every metric in the package to quickly calculate a bunch of metrics:

# calculate all metrics on patch level
calculate_lsm(landscape, level = "patch")

Utility functions

landscapemetrics further provides several visualization functions, e.g. show all labeled patches or the core area of all patches. All visualization functions start with the prefix show_ (e.g. show_cores()).

Important building blocks of the package are exported to help facilitate analysis or the development of new metrics. They all start with the prefix get_. All of them are implemented with Rcpp and have either memory or performance advantages compared to raster functions.

For more details, see the vignette("utility").

Contributing

One of the major motivations behind landscapemetrics is the idea to provide an open-source code collection of landscape metrics. This includes, besides bug reports, especially the idea to include new metrics and functions. Therefore, in case you want to suggest new metrics or functions and in the best case even contribute code, we warmly welcome to do so! For more information see CONTRIBUTING.

Maintainers and contributors must follow this repository’s CODE OF CONDUCT.

References

McGarigal K., SA Cushman, and E Ene. 2023. FRAGSTATS v4: Spatial Pattern Analysis Program for Categorical Maps. Computer software program produced by the authors; available at the following web site: https://www.fragstats.org/

Nowosad J., TF Stepinski. 2019. Information theory as a consistent framework for quantification and classification of landscape patterns. https://doi.org/10.1007/s10980-019-00830-x