create_allowable_size_Xu_problem_from_scratch: Generate a Xu problem from scratch but insure it's less than...

create_allowable_size_Xu_problem_from_scratchR Documentation

Generate a Xu problem from scratch but insure it's less than a given size

Description

Generate a Xu biodiversity problem based on 4 input control parameters rather than reading it from a file.

Usage

create_allowable_size_Xu_problem_from_scratch(
  max_allowed_num_spp,
  parameters,
  integerize,
  default_num_prob_size_tries_allowed = 20
)

Arguments

max_allowed_num_spp

integer maximum number of species allowed in the problem (to keep from generating problems that are too large when trying to keep the run-time down)

parameters

parameters list for the run, usually derived from project.yaml and can have a varying number and set of elements depending on the run

integerize

function to use in converting floats to ints

default_num_prob_size_tries_allowed

integer number of retries of problem creation to try to find one no larger than a given number of species

Value

Returns a PU_spp_pair_info_class object or quits if number of allowed retries is exceeded


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