R/default_params_doc.R

Defines functions default_params_doc

Documented in default_params_doc

#' Default parameter documentation
#'
#' @param param_space_name A string with the parameter space to run. Can
#' be \code{"oceanic_ontogeny"}, \code{"oceanic_sea_level"},
#' \code{"oceanic_ontogeny_sea_level"},
#' \code{"nonoceanic"}, \code{"nonoceanic_sea_level"}, or
#' \code{"nonoceanic_land_bridge"}.
#' @param param_set A numeric with the line corresponding to parameter set to
#' run, as found in the file named in \code{param_space}.
#' @param replicates A numeric for the number of replicates for the
#' simulations
#' @param save_output A boolean to determine whether to save or return output.
#' @param param_space tibble of the parameter space.
#' @param sim_pars A list of simulation parameters.
#' @param sim A list of simulation output from
#' \code{\link{DAISIE_sim_constant_rate}()},
#' \code{\link{DAISIE_sim_time_dependent}()} or
#' \code{\link{DAISIE_sim_constant_rate_shift}()}
#' @param ml Output from \code{\link[DAISIE]{DAISIE_ML_CS}()}
#' @param sim_1 A list of simulation output from
#' \code{\link[DAISIE]{DAISIE_sim_constant_rate}()},
#' \code{\link[DAISIE]{DAISIE_sim_time_dependent}()} or
#' \code{\link[DAISIE]{DAISIE_sim_constant_rate_shift}()}
#' @param sim_2 A list of simulation output from
#' \code{\link[DAISIE]{DAISIE_sim_constant_rate}},
#' \code{\link[DAISIE]{DAISIE_sim_time_dependent}()} or
#' \code{\link[DAISIE]{DAISIE_sim_constant_rate_shift}()}
#' @param spec_error A list with three elements each with a numeric
#' vector.
#' @param endemic_error A list with one element with a numeric vector.
#' @param nonendemic_error A list with one element with a numeric vector.
#' @param spec_baseline_error A list with three elements each with
#' a numeric vector.
#' @param endemic_baseline_error A list with one element with a numeric
#' vector.
#' @param nonendemic_baseline_error A list with one element with a numeric
#' vector.
#'
#'
#' @return Nothing
#'
default_params_doc <- function(
  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
) {
  # Nothing
}
xieshu95/robustness documentation built on April 13, 2020, 1 p.m.