Diff of /R/package.R [000000] .. [dfe06d]

Switch to unified view

a b/R/package.R
1
#' outbreaker2: a platform for disease outbreak reconstruction
2
#'
3
#' This package provides a statistical platform for reconstructing transmission
4
#' trees ('who infects whom') in densely sampled disease outbreaks. It
5
#' reimplements, as a particular case, the model of 'outbreaker' (see
6
#' references). 'outbreaker2' extends and replaces 'outbreaker'. \cr
7
#'
8
#' The emphasis of 'outbreaker2' is on modularity, which enables customisation
9
#' of priors, likelihoods and even movements of parameters and augmented data by
10
#' the user. This the dedicated vignette on this topic
11
#' \code{vignette("outbreaker2_custom")}.\cr
12
#'
13
#' The main functions of the package are:
14
#' \itemize{
15
#'
16
#' \item \code{\link{outbreaker}}: main function to run analyses.
17
#'
18
#' \item \code{\link{outbreaker_data}}: function to process input data.
19
#'
20
#' \item \code{\link{create_config}}: function to create default and customise
21
#' configuration settings.
22
#'
23
#' \item \code{\link{custom_priors}}: function to specify customised prior
24
#' functions.
25
#'
26
#' \item \code{\link{custom_likelihoods}}: function to specify customised likelihoods
27
#' functions.
28
#'
29
#' \item \code{\link{custom_moves}}: function to create default and customise movement
30
#' functions.
31
#'
32
#' }
33
#'
34
#'
35
#' @author Thibaut Jombart \email{thibautjombart@@gmail.com}.
36
#'
37
#' @name outbreaker_package
38
#'
39
#' @importFrom utils packageDescription
40
#'
41
NULL