extract_lsm: extract_lsm

Description Usage Arguments Details Value See Also Examples

View source: R/extract_lsm.R

Description

Extract metrics

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
extract_lsm(landscape, y, metric, name, type, what, directions, progress,
  ...)

## S3 method for class 'RasterLayer'
extract_lsm(landscape, y, metric = NULL,
  name = NULL, type = NULL, what = NULL, directions = 8,
  progress = FALSE, ...)

## S3 method for class 'RasterStack'
extract_lsm(landscape, y, metric = NULL,
  name = NULL, type = NULL, what = NULL, directions = 8,
  progress = FALSE, ...)

## S3 method for class 'RasterBrick'
extract_lsm(landscape, y, metric = NULL,
  name = NULL, type = NULL, what = NULL, directions = 8,
  progress = FALSE, ...)

## S3 method for class 'stars'
extract_lsm(landscape, y, metric = NULL, name = NULL,
  type = NULL, what = NULL, directions = 8, progress = FALSE, ...)

## S3 method for class 'list'
extract_lsm(landscape, y, metric = NULL, name = NULL,
  type = NULL, what = NULL, directions = 8, progress = FALSE, ...)

Arguments

landscape

Raster* Layer, Stack, Brick or a list of rasterLayers.

y

2-column matrix with coordinates, SpatialPoints, SpatialLines or sf point geometries.

metric

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

name

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

type

Type according to FRAGSTATS grouping (e.g. 'aggregation metrics').

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").

directions

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

progress

Print progress report.

...

Arguments passed to calculate_lsm().

Details

This functions extracts the metrics of all patches the spatial object(s) y (e.g. spatial points) are located within. Only patch level metrics are possible to extract. Please be aware that the output is sligthly different to all other lsm-function of landscapemetrics. Returns a tibble with chosen metrics and the ID of the spatial objects.

Value

tibble

See Also

calculate_lsm

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
points <- matrix(c(10, 5, 25, 15, 5, 25), ncol = 2, byrow = TRUE)
extract_lsm(landscape, y = points)
extract_lsm(landscape, y = points, type = "aggregation metric")

points_sp <- sp::SpatialPoints(points)
extract_lsm(landscape, y = points_sp, what = "lsm_p_area")

## Not run: 
# use lines (works only if rgeos is installed)
x1 <- c(1, 5, 15, 10)
y1 <- c(1, 5, 15, 25)

x2 <- c(10, 25)
y2 <- c(5, 5)

sample_lines <- sp::SpatialLines(list(sp::Lines(list(sp::Line(cbind(x1, y1)),
sp::Line(cbind(x2, y2))), ID = "a")))
extract_lsm(landscape, y = sample_lines, what = "lsm_p_area")

## End(Not run)

r-spatialecology/landscapemetrics documentation built on April 30, 2019, 6:01 a.m.