gen_single_bdprob_APP: Generate a single biodiversity problem with error added to it

gen_single_bdprob_APPR Documentation

Generate a single biodiversity problem with error added to it

Description

All values that are altered for the apparent problem should be assumed to be altered in the APP_prob_info_class object in the problem's APP_prob_info slot. Values in the main part of the Xu_bdprob_APP object should be the same as the values for the underlying COR problem that the APP problem is adding error to, with the exception of a few object-specific things like the UUID of the APP problem itself.

Usage

gen_single_bdprob_APP(
  Xu_bdprob_COR,
  parameters,
  starting_dir,
  gen_cost_errors,
  gen_FP_FN_errors,
  compound_err_name = NULL,
  ret_vals_from_build_const_err = NULL,
  ret_vals_from_apply_cost_errors = NULL
)

Arguments

Xu_bdprob_COR

correct Xu problem that is to have error added to it

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

starting_dir

string containing full path of top directory where problems and/or runs are to be created

gen_cost_errors

boolean flag indicating whether to add cost error; TRUE implies add cost error and FALSE implies don't add cost error

gen_FP_FN_errors

boolean flag indicating whether to add false positives and/or false negatives; TRUE implies add FP/FN error and FALSE implies don't add FP/FN error

compound_err_name

string containing name of compound error condition

ret_vals_from_build_const_err

list of return values from building constant error values if already done, NULL if not already done

ret_vals_from_apply_cost_errors

list of return values from building cost error values if already done, NULL if not already done

Value

Returns apparent version of either a Xu_bd_problem or a Xu_wrapped_bd_problem


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