default_params_doc: Default parameter documentation to inherit from

In Neves-P/islandpaleoarea: Paleo-Area Influence on Island Evolutionary Models

Default parameter documentation to inherit from

Description

Default parameter documentation to inherit from

Usage

default_params_doc(
  results_path,
  archipelago_data,
  pars,
  model,
  M,
  pars_res_df,
  ordered_results,
  best_models,
  standardisation
)

Arguments

results_path	A string with valid path for folder containing model fitting results as obtained from runs on Peregrine HPCC via the contained R and bash scripts on this package.
archipelago_data	List with DAISIE data for one of the considered archipelagos
pars	Numeric vector with CES rates and K: lamda_c, mu, K, gamma, lambda_a
model	Numeric integer or vector of integers: model number as described in Valente et al 2020.
M	Numeric, number of mainland species
pars_res_df	Data frame with results of one model for all archipelagos and ages
ordered_results	Data frame with all the results, BIC and BIC weights ordered by age and model for all archipelagos
best_models	A numeric vector with the numbers of the parameters to be plotted
standardisation	String which can be "difference" or "ratio", or defaults to FALSE. "difference" standardises estimated parameters by taking the difference of each time point in relation to the first time point, "ratio" does the same but takes the ratio as opposed to the difference and FALSE presents the absolute estimates

Value

Nothing

Author(s)

Pedro Santos Neves

Neves-P/islandpaleoarea documentation built on Feb. 10, 2024, 8:46 a.m.