set_up_for_and_run_simple_richness: Set up for and run simple_richness

In langfob/bdpg: Package For Building and Testing Biodiversity Problem Generators

Set up for and run simple_richness

Description

Set up for and run simple_richness for either COR or APP

Usage

set_up_for_and_run_simple_richness(
  num_spp,
  num_PUs,
  bpm,
  PU_costs,
  spp_rep_targets,
  forward,
  rsrun,
  top_dir,
  save_inputs,
  save_outputs
)

Arguments

num_spp	integer number of species in the problem
num_PUs	integer number of planning units
bpm	bipartite matrix; integer matrix with one row for each species and one column for each planning unit. Each matrix entry specifies whether that species occupies that planning unit; 1 indicates the species does occupy the planning unit and 0 indicates it does not. Same as occ_matrix.
PU_costs	numeric vector of planning unit costs
spp_rep_targets	numeric vector with a target abundance for each species in the problem
forward	boolean indicating whether to do the greedy search in the forward direction (adding PUs to the solution set) or the backward direction (removing PUs from the solution set); TRUE implies forward
rsrun	an RSrun (reserve selection run) object, e.g., a marxan run
top_dir	character string giving the path to the top directory of the tree where the object is written out, usually something like the tzar output directory of the experiment followed by some object-specific information and the UUID of the object, e.g., ~/tzarout/RSprob-COR-Base.299140ae-3be2-4331-bb72-b24570902587
save_inputs	boolean indicating whether input model and input params should be saved to disk
save_outputs	boolean indicating whether results and simple_richness_controls_and_results params should be saved to disk

Value

Returns named list of simple_richness control and return values

langfob/bdpg documentation built on Dec. 8, 2022, 5:33 a.m.