scale_sample: scale_sample

Description

Metrics on changing sample scale

Usage

scale_sample(
  landscape,
  y,
  shape = "square",
  size,
  transform = TRUE,
  verbose = TRUE,
  progress = FALSE,
  ...
)

Value

tibble

Arguments

landscape: Raster* Layer, Stack, Brick, SpatRaster (terra), stars, or a list of rasterLayers.
y: Point geometry as SpatVector or sf object or 2-column matrix with coordinates.
shape: String specifying plot shape. Either "circle" or "square"
size: Approximated size of sample plot. Equals the radius for circles or half of the side-length for squares in mapunits. For lines size equals the width of the buffer.
transform: Logical if planar CRS are transformed to lon/lat for accuracy during area calculations of buffer areas.
verbose: Print warning messages.
progress: Print progress report.
...: Arguments passed on to calculate_lsm().

Details

This function calculates the selected metrics in sub-sequential buffers around point(s) of interest. To see more details about arguments passed on to the metrics, please see calculate_lsm().

The metrics can be specified by the arguments what, level, metric, name and/or type (combinations of different arguments are possible (e.g. level = "class", type = "aggregation metric"). If an argument is not provided, automatically all possibilities are selected. Therefore, to get all available metrics, don't specify any of the above arguments.

For all metrics based on distances or areas please make sure your data is valid using check_landscape.

Please be aware that the output is slightly different to all other lsm-function of landscapemetrics.

The size of the actual sampled landscape can be different to the provided size due to two reasons. Firstly, because clipping raster cells using a circle or a sample plot not directly at a cell center lead to inaccuracies. Secondly, sample plots can exceed the landscape boundary. Therefore, we report the actual clipped sample plot area relative in relation to the theoretical, maximum sample plot area e.g. a sample plot only half within the landscape will have a percentage_inside = 50. Additionally, if the polygon representing the sample plot is smaller than the cell size of the raster, the percentage_inside may exceed 100%. To calculate the area of the buffer zones, the function terra::expanse() is used. The area results may be influenced by the CRS and the transform argument.

Examples

Run this code

my_points <- matrix(c(1265000, 1250000, 1255000, 1257000), ncol = 2, byrow = TRUE)
my_points <- terra::vect(my_points, crs = terra::rast(landscapemetrics::augusta_nlcd))

scale_sample(landscape = terra::rast(landscapemetrics::augusta_nlcd), y = my_points,
size = c(500, 750, 1000), what = c("lsm_l_ent", "lsm_l_mutinf"))