destination: helper function for destination area

View source: R/constructors.R

destinationR Documentation

helper function for destination area

Description

This function defines the properties of the destination area using the constructor.

Usage

destination(
  window = NULL,
  survival,
  recovery,
  xrange = c(0, 0),
  yrange = c(0, 0),
  crs,
  recovery_data = NULL
)

Arguments

window

object of class "owin":observation window in two-dimensional plane

survival

function: survival function defined over the whole destination area, independent of the origin

recovery

constant function: recovery probability, must be constant over whole destination area

xrange

vector in the form of c(xmin,xmax). To define line or rectangle xrange and yrange can be used instead of window.

yrange

vector in the form of c(ymin,ymax). To define line or rectangle xrange and yrange can be used instead of window.

crs

coordinate system of destination

recovery_data

empty space for simulated or real-world recovery data

Value

object of class "destination": contains list of window, survival and recovery for the destination area

Examples

{
     w_a <- destination(survival = function(w) 0.3,
     recovery = function(w) 0.01,
     xrange = c(0,1),
     crs = "EPSG:4326" )
 }

SaskiaSchirmer/CONSURE documentation built on Sept. 3, 2023, 8:52 a.m.