plot-methods: Plot

In nandadorea/vetsyn: Tools for Syndromic Surveillance Implementation

Plot

Description

Plot a syndromic (syndromicD or syndromicW) object.

Usage

## S4 method for signature 'syndromicW'
plot(x, syndromes = NULL, window = 52,
  baseline = FALSE, UCL = 1, algorithms = NULL, limit = NULL)

## S4 method for signature 'syndromicW'
plot(x, syndromes = NULL, window = 52,
  baseline = FALSE, UCL = 1, algorithms = NULL, limit = NULL)

Arguments

x	a syndromic object
syndromes	an optional parameter, if not specified, all columns in the slot observed (or baseline of the syndromic object will be used. The user can choose to restrict the plotting to a few syndromic groups listing their name or column position in the observed matrix. See examples.
window	the number of time points to plot, always finishing at the last time point recorded.
baseline	whether to plot the baseline, by default equal to TRUE.
UCL	the dimension of the slot UCL, from the syndromic object, from which the user wants to plot the UCL. Set to NULL or to 0 if it is not desired to plot the UCL.
algorithms	an optional parameter specifying which dimensions of the alarm slot to plot. If not specified (NULL), all are plotted. If set to zero, none are plotted.
limit	an optional parameter establishing a score above which alarms are considered worth of notice. Notice that this is not a statistical value, but a score equivalent to the number of algorithms employed and the number of limits set to them. See the tutorial for details.

Methods

signature(object = "syndromicW")

Show information for the syndromic object.

nandadorea/vetsyn documentation built on April 30, 2022, 1:15 a.m.