combine_arrivals: Sum arrivals across entry pathways

View source: R/combine_arrivals.R

combine_arrivalsR Documentation

Sum arrivals across entry pathways

Description

Sums estimated arrivals rates across all entry pathways.

Usage

combine_arrivals(
  x,
  outfile,
  summarise_uncertainty = FALSE,
  return_rast = FALSE
)

Arguments

x

Character vector giving file path(s) to rasters to be included in the summation. All rasters must have the same extent and resolution.

outfile

Character. Output raster file path. If not provided, the RasterLayer will be returned to R.

summarise_uncertainty

Logical. If TRUE, and if probability has length > 1, the arrival frequency surfaces for the values of probability will be summarised to their median, min, and max cell-wise values (in that order).

return_rast

Logical. Should the RasterLayer be returned to R? Ignored if outfile is not provided.

Value

If outfile is specified, the resulting RasterLayer is saved to outfile. If return_rast is TRUE or outfile is not specified, the resulting RasterLayer is returned, otherwise NULL is returned invisibly. If summarise_uncertainty is TRUE and rasters passed to x are multiband, then the resulting stack will have three layers equal to the cell-wise median, minimum, and maximum of the layers, respectively.


jscamac/edmaps documentation built on June 11, 2022, 1:26 a.m.