R/lsm-null.R

In dd-harp/MicroMoB: Discrete Time Systems for Robust Analytics for Malaria Policy (RAMP), and Transmission Dynamics and Control of Mosquito-Borne Pathogens Transmission

# specialized methods for the null model of LSM

#' @title Set up the null model for LSM
#' @description This method dispatches on the type of `pars$LSM`
#' @inheritParams TreatHabitats
#' @return a [list]
#' @export
TreatHabitats.null <- function(t, pars) {
  pars
}

#' @title Modify effects of LSM, the null model
#' @description This method dispatches on the type of `pars$LSM`
#' @inheritParams LSM_Effects
#' @return a [list]
#' @export
LSM_Effects.null <- function(t, pars) {
   pars
}

#' @title Modify effects of LSM, the null model
#' @description This method dispatches on the type of `pars$LSM`
#' @inheritParams LSM_EffectSizes
#' @return a [list]
#' @export
LSM_EffectSizes.null <- function(t, pars) {
   pars
}

#' @title Make parameters for the null model of LSM (do nothing)
#' @param pars a [list]
#' @return a [list]
#' @export
setup_lsm_null <- function(pars) {
  LSM <- list()
  class(LSM) <- "null"
  pars$LSM <- LSM
  return(pars)
}