R/ODEsensitivity-package.R

In surmann/ODEsensitivity: Sensitivity Analysis of Ordinary Differential Equations

#' @title
#' Performing Sensitivity Analysis in ODE Models
#'
#' @description
#' \code{ODEsensitivity} provides methods to perform sensitivity analysis (SA)
#' in ordinary differential equation (ODE) models. Its functions are based on 
#' the implementations of Morris and Sobol' SA in the
#' \code{\link{sensitivity}} package (Pujol et al., 2015). However, a modified 
#' version of the \code{\link{sensitivity}}-package had been required that enables 
#' \code{\link[sensitivity]{morris}}, 
#' \code{\link[sensitivity]{soboljansen}} and
#' \code{\link[sensitivity]{sobolmartinez}} to handle three-dimensional
#' arrays as model outputs (This is why \code{ODEsensitivity} depends on
#' \code{\link{sensitivity}} version >= 1.12.1).
#' Each element of the third dimension of the output 
#' array is then used to contain the results for one state variable of the ODE 
#' model. Each element of the second dimension of the output array is used for 
#' one timepoint.
#'
#' @details
#' The main functions are \code{\link{ODEmorris}} and \code{\link{ODEsobol}},
#' which are generic functions. They have default methods for general ODE models
#' (\code{\link{ODEmorris.default}, \link{ODEsobol.default}}) as well as methods
#' for objects of class \code{ODEnetwork} (\code{\link{ODEmorris.ODEnetwork}, 
#' \link{ODEsobol.ODEnetwork}}). For the latter two methods, the package 
#' \code{ODEnetwork} is required.
#' 
#' See the \code{\link{sensitivity}} package and its 
#' \code{\link[sensitivity]{morris}, \link[sensitivity]{soboljansen}} and 
#' \code{\link[sensitivity]{sobolmartinez}} implementations for further 
#' information on sensitivity analysis in \code{R}.
#'
#' @docType package
#' @name ODEsensitivity
NULL