meanHHH

sizeHHH

decompose.hhh4

The functions documented here are considered internal,
 i.e., not intended to be called by the user. They are used by
 add-on packages dealing with <code>hhh4</code> models.

internal

hhh4_internals

Statistical methods for the modeling and monitoring of time series
of counts, proportions and categorical data, as well as for the modeling
of continuous-time point processes of epidemic phenomena.
The monitoring methods focus on aberration detection in count data time
series from public health surveillance of communicable diseases, but
applications could just as well originate from environmetrics,
reliability engineering, econometrics, or social sciences. The package
implements many typical outbreak detection procedures such as the
(improved) Farrington algorithm, or the negative binomial GLR-CUSUM
method of Hoehle and Paul (2008) <doi:10.1016/j.csda.2008.02.015>.
A novel CUSUM approach combining logistic and multinomial logistic
modeling is also included. The package contains several real-world data
sets, the ability to simulate outbreak data, and to visualize the
results of the monitoring in a temporal, spatial or spatio-temporal
fashion. A recent overview of the available monitoring procedures is
given by Salmon et al. (2016) <doi:10.18637/jss.v070.i10>.
For the retrospective analysis of epidemic spread, the package provides
three endemic-epidemic modeling frameworks with tools for visualization,
likelihood inference, and simulation. hhh4() estimates models for
(multivariate) count time series following Paul and Held (2011)
<doi:10.1002/sim.4177> and Meyer and Held (2014) <doi:10.1214/14-AOAS743>.
twinSIR() models the susceptible-infectious-recovered (SIR) event
history of a fixed population, e.g, epidemics across farms or networks,
as a multivariate point process as proposed by Hoehle (2009)
<doi:10.1002/bimj.200900050>. twinstim() estimates self-exciting point
process models for a spatio-temporal point pattern of infective events,
e.g., time-stamped geo-referenced surveillance data, as proposed by
Meyer et al. (2012) <doi:10.1111/j.1541-0420.2011.01684.x>.
A recent overview of the implemented space-time modeling frameworks
for epidemic phenomena is given by Meyer et al. (2017)
<doi:10.18637/jss.v077.i11>.

Sebastian Meyer

surveillance

Temporal and Spatio-Temporal Modeling and Monitoring of Epidemic
Phenomena

Andrea Riebler

Daniel Sabanes Bove

Stefan Steiner

Mikko Virtanen

Wei Wei

Valentin Wimmer

R Core Team 

Howard Burkom

Thais Correa

Mathias Hofmann

Christian Lang

Juliane Manitz

Dirk Schumacher

Leonhard Held

Michael Hoehle

Michaela Paul

Maelle Salmon

hhh4_internals function

<dl> <dt>theta,coefs</dt>
<dd>numeric vector of untransformed model parameters,
 i.e., the <code>coefficients</code> element of the <code>"hhh4"</code> object.</dd> <dt>model</dt>
<dd>the model terms as returned by the
 <code><a href="/link/terms?package=surveillance&version=1.20.3" data-mini-rdoc="surveillance::terms">terms</a></code>-method for <code>"hhh4"</code> objects.</dd> <dt>subset</dt>
<dd>vector of time points for which to compute the component
 means. Defaults to the fitted time range. For <code>sizeHHH</code>,
 <code>subset=NULL</code> means to return the vector of dispersion
 parameters.</dd> <dt>total.only</dt>
<dd>logical. Should only the total mean (epidemic +
 endemic) be returned in a <code>length(subset)</code> x nUnit matrix?
 Otherwise, a list of such matrices is returned, giving the values of
 the various model components separately (as well as the total).</dd> <dt>x</dt>
<dd>a fitted <code>hhh4</code> model.</dd> <dt>...</dt>
<dd>unused.</dd></dl>

Arguments

Author

Internal Functions Dealing with hhh4 Models — hhh4_internals

<dl>

 <dt>theta,coefs</dt>
<dd>numeric vector of untransformed model parameters,
 i.e., the <code>coefficients</code> element of the <code>"hhh4"</code> object.</dd>

 <dt>model</dt>
<dd>the model terms as returned by the
 <code><a href='https://rdrr.io/r/stats/terms.html'>terms</a></code>-method for <code>"hhh4"</code> objects.</dd>

 <dt>subset</dt>
<dd>vector of time points for which to compute the component
 means. Defaults to the fitted time range. For <code>sizeHHH</code>,
 <code>subset=NULL</code> means to return the vector of dispersion
 parameters.</dd>

 <dt>total.only</dt>
<dd>logical. Should only the total mean (epidemic +
 endemic) be returned in a <code>length(subset)</code> x nUnit matrix?
 Otherwise, a list of such matrices is returned, giving the values of
 the various model components separately (as well as the total).</dd>

 <dt>x</dt>
<dd>a fitted <code>hhh4</code> model.</dd>

 <dt>...</dt>
<dd>unused.</dd>

</dl>

Internal Functions Dealing with <code>hhh4</code> Models

hhh4_internals: Internal Functions Dealing with `hhh4` Models

Description

Usage

Arguments

Author

Details