R/read_parameters.R

In mhesselbarth/rABMP: R agent-based model for plants

#' read_parameters
#'
#' @description Read parameters from text file
#'
#' @details
#' Construct a list with all default paramerts for run_model. The parameters include:
#' \itemize{
#'   \item First item
#'   \item Second item
#' }
#'
#' @param file String with path to text file.
#' @param return_list Logical if true parameters are returned as list.
#' @param ... Arguments passed on to \code{read.table}.
#'
#' @return tibble
#'
#' @aliases read_parameters
#' @rdname read_parameters
#'
#' @references
#' Holzwarth, F., Kahl, A., Bauhus, J., Wirth, C., 2013. Many ways to die -
#' partitioning tree mortality dynamics in a near-natural mixed deciduous forest.
#' J. Ecol. 101, 220–230.
#'
# Olesen, C.R., Madsen, P., 2008. The impact of roe deer (Capreolus capreolus),
# seedbed, light and seed fall on natural beech (Fagus sylvatica) regeneration.
# For. Ecol. Manag. 255, 3962–3972.
#'
#' Pommerening, A., Maleki, K., 2014. Differences between competition kernels and
#' traditional size-ratio based competition indices used in forest ecology.
#' For. Ecol. Manage. 331, 135-143.
#'
#' Ribbens, E., Silander, J. A., & Pacala, S. W. (1994). Seedling recruitment in forests:
#' Calibrating models to predict patterns of tree seedling dispersion.
#' Ecology, 75(6), 1794-1806.
#'
#' @export
read_parameters <- function(file, return_list = TRUE, ...) {

  parameters <- tibble::as_tibble(utils::read.table(file, header = TRUE, ...))

  if (return_list) {

    parameters <- as.list(parameters)
  }

  # return result
  return(parameters)
}