Diff of /man/outbreaker_package.Rd [000000] .. [dfe06d]

Switch to unified view

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