prior3D (version 0.1.5)

evaluate_3D: Evaluate prioritization solution over 3D feature distributions

Description

Evaluate prioritization solution over 3D feature distributions.

Usage

evaluate_3D(solution, split_features)

Value

A list containing the following evaluation metrics:

• relative_held_raw: relative percentage under protection per feature and per depth level

• relative_held: mean percentage under protection of all features per depth level

• overall_held: overall percentage under protection per feature

• overall_available: relative percentage under protection per feature and per depth level, over total amount of each feature

• depth_overall_available: averages of overall_available per depth

• absolute_held: absolute value per feature and per depth under protection

• total_amount: absolute value per feature and depth level

Arguments

solution

prioritization solution SpatRaster object.

split_features

A list of SpatRaster objects representing depth zones, where each element corresponds to a different depth level, ranging from surface to the bottom of the sea. The function uses the output of the split_rast function, but other multilevel (3D) distribution data that conform to this structure is also acceptable. First list element corresponds to the shallowest distribution and the last list element to the deepest one.

Details

This function evaluates a prioritization solution over 3D feature distributions, by estimating the relative and overall percentages of features under protection, as designated by the prioritization solution.

Examples

if (FALSE) {
## This example requires commercial solver from 'gurobi' package for
## portfolio = "gap". Else replace it with e.g. portfolio = "shuffle" for using
## a free solver like the one from 'highs' package.

biodiv_raster <- get_biodiv_raster()
depth_raster <- get_depth_raster()
data(biodiv_df)

# You can split features' 2D distributions into 3D ones and then run only 3D analysis
split_features <- split_rast(biodiv_raster,
                             depth_raster,
                             breaks = c(0, -40, -200, -2000, -Inf),
                             biodiv_df)

out_3D <- prioritize_3D(split_features = split_features,
                        depth_raster = depth_raster,
                        breaks = c(0, -40, -200, -2000, -Inf),
                        biodiv_df = biodiv_df,
                        budget_percents = seq(0, 1, 0.1),
                        budget_weights = "richness",
                        threads = parallel::detectCores(),
                        portfolio = "gap",
                        portfolio_opts = list(number_solutions = 10))

evaluate_3D(out_3D$solution3D$budget0.3, split_features)
}