R/lsm-interface.R

Defines functions LSM_EffectSizes LSM_Effects TreatHabitats

Documented in LSM_Effects LSM_EffectSizes TreatHabitats

# generic methods for LSM

#' @title Modify values due to treat habitats as part of LSM,
#' called by Control->VectorControl
#' @description This method dispatches on the type of `pars$LSM`.
#' @param t current simulation time
#' @param pars a [list]
#' @return a [list]
#' @export
TreatHabitats <- function(t, pars) {
  UseMethod("TreatHabitats", pars$LSM)
}

#' @title Modify effects of LSM
#' @description This method dispatches on the type of `pars$LSM`.
#' @param t current simulation time
#' @param pars a [list]
#' @return a [list]
#' @export
LSM_Effects <- function(t, pars) {
  UseMethod("LSM_Effects", pars$LSM)
}

#' @title Compute effect sizes of LSM
#' @description This method dispatches on the type of `pars$LSM`.
#' @param t current simulation time
#' @param pars a [list]
#' @return a [list]
#' @export
LSM_EffectSizes <- function(t, pars) {
  UseMethod("LSM_EffectSizes", pars$LSM)
}
dd-harp/MicroMoB documentation built on June 6, 2024, 4:43 p.m.