st_MSI: Calculate the mean shape index of a polygons

View source: R/st_MSI.R

st_MSIR Documentation

Calculate the mean shape index of a polygons

Description

This function calculates the mean shape index of polygons.

Usage

st_MSI(
  tool = "sf",
  x,
  geom.boundary = NULL,
  field = NULL,
  do.preProcessing = TRUE,
  return.geom = FALSE,
  quiet = TRUE
)

Arguments

tool

tool to perform dissolve operation. Default is "sf". However, for complex polygons "grass" is highly recommended. Fot the use of "grass" a valid GRASS GIS-session mus be initiated. "saga" is NOT supported

x

polygon of class sf

geom.boundary

polygon of class sf representing subregions, e.g. administrative boundaries. Default: NULL

field

field name or table column (character) on which the shannon index is calculated

do.preProcessing

If TRUE (default), the input of geom.frag is, first, dissolved by field, and second, splitted to multi-parts. By this step it is assured, that polygon connected to each other are summarized

return.geom

If set to TRUE, geometries (e.g. dissolved) are returned as well. Default: FALSE

quiet

If set to FALSE actual state is printed to console. Default: TRUE.

Value

data.frame with mean shape index and area weighted mean shape index

Note

Code is based on the following references:

  • Forman, R.T.T., & Godron, M. (1986). Landscape Ecology. Cambridge.

  • Siedentop, S., Heiland, S., Lehmann, I., & Schauerte-Lüke, N. (2007). Regionale Schlüsselindikatoren nachhaltiger Flächennutzung für die Fortschrittsberichte der Nationalen Nachhaltigkeitsstrategie–Flächenziele (Nachhaltigkeitsbarometer Fläche). Abschlussbericht, BBR-Forschungen, H, 130.


raff-k/VLSM documentation built on Oct. 13, 2023, 11:13 a.m.