plotfit: S3 method for objects of class 'R0.R' or 'R0.sR'

View source: R/plotfit.R

plotfitR Documentation

S3 method for objects of class R0.R or R0.sR

Description

This method ensures compliance with CRAN checks etc. It is used to properly call plotfit.R0.R() and plotfit.R0.sR() and build corresponding plots.

Usage

plotfit(x, xscale = "w", SB.dist = TRUE, ...)

Arguments

x

An output of estimate.R() (class R0.sR) or est.R0.xx() (class R0.R).

xscale

Scale to be adjusted on x-axis. Can be d (day), w (week (default)), f (fornight), m (month).

SB.dist

Boolean. Should the R distirbution throughout the epidemic be plotted for the SB method (defaults to TRUE) ?

...

Parameters passed to inner functions.

Details

For internal use.

This method is designed to either call plotfit.R0.R() or plotfit.R0.sR(), and complies with S3 requirements at the time of writing.

It allows plotting the goodness-of-fit of an estimated model to the original epidemic curve provided the user.

Depending on the method of estimation, the graphical output will vary :

  • EG, ML and TD methods will show the original epidemic curve, along with the best-fitting prediction model,

  • AR will only show the epidemic curve, since no actual model is computed,

  • SB will display 9 density curves for the R distribution throughout the epidemic.

Value

This function does not return any data.

Author(s)

Pierre-Yves Boelle, Thomas Obadia


tobadia/R0 documentation built on Sept. 24, 2023, 5:16 p.m.