View source: R/mland_overlap.R
mland_overlap | R Documentation |
Returns matrices informing the degree of overlapped area between buffers of a 'MultiLand' object.
mland_overlap(
x,
points = NULL,
radii = NULL,
digits = 2,
perc = TRUE,
title = "id"
)
x |
An object of class 'Multiland' generated with |
points |
Numeric or character vector depicting the points to be considered. If NULL, all points will be taken into account. See Details. |
radii |
Numeric vector depicting the radii to be considered. If NULL, all radii will be taken into account. |
digits |
Numeric. Number of digits for the values of overlapped areas. Default is 2. |
perc |
Logical. If TRUE (default) the degree of overlapped areas will be presented as percentages. If FALSE, proportions will be outputted. |
title |
One of the following: "id" to output each point with its id (default), or "sitename" to
output each point with its pre-defined point name in |
If argument points
is a character vector,
mland_overlap()
will assume that the 'MultiLand' object inputted in argument x
was created with
site_ref = TRUE
. This is, there is a column/attribute in the points layer with the names for
each distinct point. Therefore, the inputted values in argument points
will be taken as these
identification names. Otherwise, if a numeric vector is declared, the inputted values
will be taken as the automatically generated point ids (created when executing mland()
).
A list with as many elements as different radius in x
. Each element contains a
matrix with the percentages (or proportions if perc = FALSE
) of overlapping of buffer areas.
# Loads a 'MultiLand' object
ernesdesign <- system.file("extdata", "ernesdesign.zip", package = "multilandr")
ernesdesign <- mland_load(ernesdesign)
# Returns a matrix with the percentage of overlapping between buffers of each radii
mland_overlap(ernesdesign)
# Selects only one radius and return the site names rather than the ids
mland_overlap(ernesdesign, radii = 5000, title = "sitename")
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.