https://github.com/cran/epiR
Tip revision: a59094f21be9a1bd4e76c42c8df5b7a8f9730e9b authored by Mark Stevenson on 28 March 2023, 06:20:02 UTC
version 2.0.59
version 2.0.59
Tip revision: a59094f
epi.dgamma.Rd
\name{epi.dgamma}
\alias{epi.dgamma}
\title{Estimate the precision of a [structured] heterogeneity term
}
\description{
Returns the precision of a [structured] heterogeneity term after one has specified the amount of variation a priori.
}
\usage{
epi.dgamma(rr, quantiles = c(0.05, 0.95))
}
\arguments{
\item{rr}{the lower and upper limits of relative risk, estimated \emph{a priori}.}
\item{quantiles}{a vector of length two defining the quantiles of the lower and upper relative risk estimates.}
}
\value{
Returns the precision (the inverse variance) of the heterogeneity term.
}
\references{
Best, NG. WinBUGS 1.3.1 Short Course, Brisbane Australia, November 2000.
}
\examples{
## EXAMPLE 1:
## Suppose we are expecting the lower 5\% and upper 95\% confidence interval
## of relative risk in a data set to be 0.5 and 3.0, respectively.
## A prior estimate of the precision of the heterogeneity term would be:
tau <- epi.dgamma(rr = c(0.5, 3.0), quantiles = c(0.05, 0.95))
tau
## The estimate of the precision of the heterogeneity term (tau) is 3.37.
## This can be re-expressed using the gamma distribution. We set the mean of the
## distribution as tau and specify a large variance (that is, we are not
## certain about tau).
mean <- tau; var <- 1000
shape <- mean^2 / var
inv.scale <- mean / var
## In WinBUGS the precision of the heterogeneity term is parameterised
## as tau ~ dgamma(shape, inv.scale). Plot the probability density function
## of tau:
z <- seq(0.01, 10, by = 0.01)
fz <- dgamma(z, shape = shape, scale = 1 / inv.scale)
plot(x = z, y = fz, type = "l", ylab = "Probability density of tau")
}
\keyword{univar}% at least one, from doc/KEYWORDS
\keyword{univar}% __ONLY ONE__ keyword per line