Skip to contents

Create a new scenario based on trained model parameters

Source: R/scenario.R
scenario.Rd

This function creates a new BiodiversityScenario object that contains the projections of a model.

Usage

scenario(fit, limits = NULL, reuse_limits = FALSE, copy_model = FALSE)

# S4 method for class 'ANY'
scenario(fit, limits = NULL, reuse_limits = FALSE, copy_model = FALSE)

Arguments

fit

A BiodiversityDistribution object containing a trained model.

limits

A SpatRaster or sf object that limits the projection surface when intersected with the prediction data (Default: NULL). This can for instance be set as an expert-delineated constrain to limit spatial projections.

reuse_limits

A logical on whether to reuse limits if found in the trained BiodiversityDistribution object (Default: FALSE). See also notes!

copy_model

A logical of whether the model object is to be copied to the scenario object. Note that setting this option to TRUE can increase the required amount of memory (Default: FALSE).

Note

If a limit has been defined already during train(), for example by adding an extrapolation limit add_limits_extrapolation(), this zonal layer can be reused for the projections. Note: This effectively fixes the projections to certain areas.

Examples

if (FALSE) { # \dontrun{
  scenario(fit, limits = island_area)
} # }