get_forced_seed_value_if_necessary: Get forced seed value if necessary

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

Get forced seed value if necessary

Description

Determines whether a seed value is given or needs to be set or not generated at all based on input options in the parameters list.

Usage

get_forced_seed_value_if_necessary(
  is_rsrun,
  is_rsprob,
  parameters,
  cor_or_app_str,
  basic_or_wrapped_or_comb_str
)

Arguments

is_rsrun	boolean indicating that the seed creation test is being done just before the creation of an rs RUN object
is_rsprob	boolean indicating that the seed creation test is being done just before the creation of an rs PROBLEM object
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
cor_or_app_str	character string containing "COR" or "APP"
basic_or_wrapped_or_comb_str	character string containing "BASE" or "WRAP" or "COMB"

Details

2017 12 06 - BTL NOTE: basic_or_wrapped_or_comb_str = "COMB" does not exist at the moment, but it's mentioned in BDProb.R, so it's covered here for future compatibility.

Value

Returns an integer seed value or NA

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