diff --git a/R/res.R b/R/res.R index 84cd4a3f..366a7351 100644 --- a/R/res.R +++ b/R/res.R @@ -136,6 +136,7 @@ res_gamma_pois <- function(x, lambda = 1, theta = 0, type = "dev", simulate = FA #' #' @inheritParams params #' @param x A non-negative whole numeric vector of values. +#' @param prob A numeric vector of values between 0 and 1 of the probability of zero-inflation. #' #' @return An numeric vector of the corresponding residuals. #' @family res_dist @@ -257,6 +258,7 @@ res_pois <- function(x, lambda = 1, type = "dev", simulate = FALSE) { #' #' @inheritParams params #' @param x A non-negative whole numeric vector of values. +#' @param prob A numeric vector of values between 0 and 1 of the probability of zero-inflation. #' #' @return An numeric vector of the corresponding residuals. #' @family res_dist diff --git a/man/res_gamma_pois_zi.Rd b/man/res_gamma_pois_zi.Rd index 6efeb624..86e7d019 100644 --- a/man/res_gamma_pois_zi.Rd +++ b/man/res_gamma_pois_zi.Rd @@ -20,7 +20,7 @@ res_gamma_pois_zi( \item{theta}{A non-negative numeric vector of the dispersion for the mixture models (student, gamma-Poisson and beta-binomial).} -\item{prob}{A numeric vector of values between 0 and 1 of the probability of success.} +\item{prob}{A numeric vector of values between 0 and 1 of the probability of zero-inflation.} \item{type}{A string of the residual type. 'raw' for raw residuals 'dev' for deviance residuals and 'data' for the data.} diff --git a/man/res_pois_zi.Rd b/man/res_pois_zi.Rd index 68c907df..e79f3168 100644 --- a/man/res_pois_zi.Rd +++ b/man/res_pois_zi.Rd @@ -11,7 +11,7 @@ res_pois_zi(x, lambda = 1, prob = 0, type = "dev", simulate = FALSE) \item{lambda}{A non-negative numeric vector of means.} -\item{prob}{A numeric vector of values between 0 and 1 of the probability of success.} +\item{prob}{A numeric vector of values between 0 and 1 of the probability of zero-inflation.} \item{type}{A string of the residual type. 'raw' for raw residuals 'dev' for deviance residuals and 'data' for the data.}