File: EstimateR.Rd

package info (click to toggle)
r-cran-epiestim 2.2-4%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 636 kB
  • sloc: sh: 15; makefile: 2
file content (75 lines) | stat: -rw-r--r-- 2,078 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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/compatibility.R
\name{EstimateR}
\alias{EstimateR}
\title{Function to ensure compatibility with EpiEstim versions <2.0}
\usage{
EstimateR(
  I,
  T.Start,
  T.End,
  method = c("NonParametricSI", "ParametricSI", "UncertainSI"),
  n1 = NULL,
  n2 = NULL,
  Mean.SI = NULL,
  Std.SI = NULL,
  Std.Mean.SI = NULL,
  Min.Mean.SI = NULL,
  Max.Mean.SI = NULL,
  Std.Std.SI = NULL,
  Min.Std.SI = NULL,
  Max.Std.SI = NULL,
  SI.Distr = NULL,
  Mean.Prior = 5,
  Std.Prior = 5,
  CV.Posterior = 0.3,
  plot = FALSE,
  leg.pos = "topright"
)
}
\arguments{
\item{I}{see \code{incid} in \code{estimate_R}}

\item{T.Start}{see \code{config$t_start} in \code{estimate_R}}

\item{T.End}{see \code{config$t_end} in \code{estimate_R}}

\item{method}{see method in \code{estimate_R} (but EstimateR uses CamelCase 
where estimate_R uses snake_case for the method names)}

\item{n1}{see \code{n1} in \code{estimate_R}}

\item{n2}{see \code{n2} in \code{estimate_R}}

\item{Mean.SI}{see \code{config$mean_si} in \code{estimate_R}}

\item{Std.SI}{see \code{config$std_si} in \code{estimate_R}}

\item{Std.Mean.SI}{see \code{config$std_mean_si} in \code{estimate_R}}

\item{Min.Mean.SI}{see \code{config$min_mean_si} in \code{estimate_R}}

\item{Max.Mean.SI}{see \code{config$max_mean_si} in \code{estimate_R}}

\item{Std.Std.SI}{see \code{config$std_std_si} in \code{estimate_R}}

\item{Min.Std.SI}{see \code{config$min_std_si} in \code{estimate_R}}

\item{Max.Std.SI}{see \code{config$max_std_si} in \code{estimate_R}}

\item{SI.Distr}{see \code{config$si_distr} in \code{estimate_R}}

\item{Mean.Prior}{see \code{config$mean_prior} in \code{estimate_R}}

\item{Std.Prior}{see \code{config$std_prior} in \code{estimate_R}}

\item{CV.Posterior}{see \code{config$cv_posterior} in \code{estimate_R}}

\item{plot}{Not used anymore, only there for compatibility}

\item{leg.pos}{Not used anymore, only there for compatibility}
}
\description{
Please only use for compatibility;
Prefer the new estimate_R function instead
}