File: plot.sirspline.Rd

package info (click to toggle)
r-cran-popepi 0.4.13%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,656 kB
  • sloc: sh: 13; makefile: 2
file content (53 lines) | stat: -rw-r--r-- 1,678 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/S3_definitions.R
\name{plot.sirspline}
\alias{plot.sirspline}
\title{\code{plot} method for sirspline-object}
\usage{
\method{plot}{sirspline}(x, conf.int = TRUE, abline = TRUE, log = FALSE, type, ylab, xlab, ...)
}
\arguments{
\item{x}{an object returned by function sirspline}

\item{conf.int}{logical; default TRUE draws also the 95 confidence intervals}

\item{abline}{logical; draws a reference line where SIR = 1}

\item{log}{logical; default FALSE. Should the y-axis be in log scale}

\item{type}{select \code{type = 'n'} to plot only figure frames}

\item{ylab}{overwrites default y-axis label; can be a vector if multiple splines fitted}

\item{xlab}{overwrites default x-axis label; can be a vector if multiple splines fitted}

\item{...}{arguments passed on to plot()}
}
\value{
Always returns \code{NULL} invisibly.
This function is called for its side effects.
}
\description{
Plot SIR splines using R base graphics.
}
\details{
In \code{plot.sirspline} almost every graphical parameter are user
adjustable, such as \code{ylim}, \code{xlim}.
\code{plot.sirsplines} calls \code{lines.splines} to add lines.

The plot axis without lines can be plotted using option \code{type = 'n'}.
On top of the frame it's then possible to add a \code{grid},
\code{abline} or text before plotting the lines (see: \code{sirspline}).
}
\seealso{
Other sir functions: 
\code{\link{lines.sirspline}()},
\code{\link{sir}()},
\code{\link{sir_exp}()},
\code{\link{sir_ratio}()},
\code{\link{sirspline}()}
}
\author{
Matti Rantanen
}
\concept{sir functions}