File: stsBP-class.Rd

package info (click to toggle)
r-cran-surveillance 1.8-0-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 5,628 kB
  • ctags: 150
  • sloc: cpp: 2,458; ansic: 659; sh: 9; makefile: 8
file content (74 lines) | stat: -rwxr-xr-x 2,023 bytes parent folder | download | duplicates (2)
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
\name{stsBP-class}
\Rdversion{1.1}
\docType{class}
\alias{stsBP-class}
% %
% % other names
% %\alias{aggregate,stsBP-method}
% %\alias{plot,stsBP-method}
% %\alias{plot,stsBP,missing-method}
% \alias{nrow,stsBP-method}
% \alias{ncol,stsBP-method}
% \alias{dim,stsBP-method}
% \alias{alarms,stsBP-method}
% \alias{alarms<-,stsBP-method}
% \alias{upperbound,stsBP-method}
% \alias{upperbound<-,stsBP-method}
% \alias{control,stsBP-method}
% \alias{control<-,stsBP-method}
% \alias{epoch,stsBP-method}
% \alias{epoch<-,stsBP-method}
% \alias{epochInYear,stsBP-method}
% \alias{observed,stsBP-method}
% \alias{observed<-,stsBP-method}
% \alias{population,stsBP-method}
% \alias{population<-,stsBP-method}
% \alias{multinomialTS,stsBP-method}
% \alias{multinomialTS<-,stsBP-method}
% \alias{neighbourhood,stsBP-method}
% \alias{neighbourhood<-,stsBP-method}
% \alias{colnames,stsBP,missing,missing-method}
% \alias{initialize,stsBP-method}
% \alias{as.data.frame,stsBP-method}

%Coerce method to convert to sts object
\alias{coerce,sts,stsBP-method}

\encoding{latin1}

\title{Class "stsBP" -- a class inheriting from class \code{sts} which
  allows the user to store the results of back-projecting or nowcasting
  surveillance time series} 

\description{
  A class inheriting from class \code{sts}, but with additional slots
  to store the result and associated confidence intervals from back
  projection of a \code{sts} object.

}

\section{Slots}{
  The slots are as for \code{"\linkS4class{sts}"}. However, two
  additional slots exists.
  
  \describe{
    \item{\code{ci}:}{An array containing the upper and lower limit
      of the confidence interval.}
    \item{\code{lambda}:}{Back projection component}
  }
}
\section{Methods}{
  The methods are the same as for \code{"\linkS4class{sts}"}.

  \itemize{
    \item{\code{signature(from = "sts", to = "stsBP")}}{
      Convert an object of class \code{sts} to class \code{stsBP}.
    }
  }
} %end section methods.


\author{M. \enc{Hhle}{Hoehle}}


\keyword{classes}