default_params_doc: Default parameter documentation

Description Usage Arguments Value

View source: R/default_params_doc.R

Description

Default parameter documentation

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
default_params_doc(
  param_space_name,
  param_set,
  replicates,
  save_output,
  param_space,
  sim_pars,
  sim,
  ml,
  sim_1,
  sim_2,
  spec_error,
  endemic_error,
  nonendemic_error,
  spec_baseline_error,
  endemic_baseline_error,
  nonendemic_baseline_error
)

Arguments

param_space_name

A string with the parameter space to run. Can be "oceanic_ontogeny", "oceanic_sea_level", "oceanic_ontogeny_sea_level", "nonoceanic", "nonoceanic_sea_level", or "nonoceanic_land_bridge".

param_set

A numeric with the line corresponding to parameter set to run, as found in the file named in param_space.

replicates

A numeric for the number of replicates for the simulations

save_output

A boolean to determine whether to save or return output.

param_space

tibble of the parameter space.

sim_pars

A list of simulation parameters.

sim

A list of simulation output from DAISIE_sim_constant_rate(), DAISIE_sim_time_dependent() or DAISIE_sim_constant_rate_shift()

ml

Output from DAISIE_ML_CS()

sim_1

A list of simulation output from DAISIE_sim_constant_rate(), DAISIE_sim_time_dependent() or DAISIE_sim_constant_rate_shift()

sim_2

A list of simulation output from DAISIE_sim_constant_rate, DAISIE_sim_time_dependent() or DAISIE_sim_constant_rate_shift()

spec_error

A list with three elements each with a numeric vector.

endemic_error

A list with one element with a numeric vector.

nonendemic_error

A list with one element with a numeric vector.

spec_baseline_error

A list with three elements each with a numeric vector.

endemic_baseline_error

A list with one element with a numeric vector.

nonendemic_baseline_error

A list with one element with a numeric vector.

Value

Nothing


xieshu95/robustness documentation built on April 13, 2020, 1 p.m.