nb_pi {predint} | R Documentation |
Simple uncalibrated prediction intervals for negative-binomial data
Description
nb_pi()
is a helper function that is internally called by neg_bin_pi()
. It
calculates simple uncalibrated prediction intervals for negative-binomial data
with offsets.
Usage
nb_pi(
newoffset,
histoffset,
lambda,
kappa,
q = qnorm(1 - 0.05/2),
alternative = "both",
newdat = NULL,
histdat = NULL,
algorithm = NULL
)
Arguments
newoffset |
number of experimental units in the future clusters |
histoffset |
number of experimental units in the historical clusters |
lambda |
overall Poisson mean |
kappa |
dispersion parameter |
q |
quantile used for interval calculation |
alternative |
either "both", "upper" or "lower".
|
newdat |
additional argument to specify the current data set |
histdat |
additional argument to specify the historical data set |
algorithm |
used to define the algorithm for calibration if called via
|
Details
This function returns a simple uncalibrated prediction interval
with as the number of experimental units in
future clusters,
as the estimate for the Poisson mean obtained from the
historical data,
as the estimate for the dispersion parameter,
as the number of experimental units per historical cluster and
.
The direct application of this uncalibrated prediction interval to real life data
is not recommended. Please use the neg_bin_pi()
function for real life applications.
Value
np_pi
returns an object of class c("predint", "negativeBinomialPI")
.
Examples
# Prediction interval
nb_pred <- nb_pi(newoffset=3, lambda=3, kappa=0.04, histoffset=1:9, q=qnorm(1-0.05/2))
summary(nb_pred)