Merge pull request #75 from poissonconsulting/alphabetize-params

Alphabetize params.R and reflow parameter descriptions
poissonconsulting · Aug 20, 2024 · fb429fd · fb429fd
2 parents 772dc62 + 18b667e
commit fb429fd
Show file tree

Hide file tree

Showing 65 changed files with 279 additions and 155 deletions.
diff --git a/R/params.R b/R/params.R
@@ -8,38 +8,46 @@
 #' A string is a non-missing character scalar.
 #'
 #' @keywords internal
-#' @param x An object.
+#' @name params
 #' @param ... Other arguments passed to methods.
-#' @param nas A flag specifying whether to also fill missing values.
-#' @param n A non-negative whole number of the number of random samples to generate.
-#' @param conf_level A numeric scalar between 0 and 1
-#' specifying the confidence level.
-#' @param value A scalar of the value to replace values with.
+#' @param alpha The first shape parameter of the Beta distribution.
+#' @param beta The second shape parameter of the Beta distribution.
+#' @param conf_level A numeric scalar between 0 and 1 specifying the confidence
+#'   level.
 #' @param directional A flag specifying whether probabilities less than 0.5
-#' should be returned as negative values.
-#' @param res A flag specifying whether to return the deviance residual as opposed to the deviance.
+#'   should be returned as negative values.
+#' @param lambda A non-negative numeric vector of means.
+#' @param log A flag specifying whether to return the log-transformed value.
+#' @param lower.tail A flag specifying whether to return the lower or upper tail
+#'   of the distribution.
 #' @param mean A numeric vector of the means.
-#' @param sd A non-negative numeric vector of the standard deviations.
 #' @param meanlog A numeric vector of the means on the log scale.
-#' @param sdlog A non-negative numeric vector of the standard deviations on the log scale.
-#' @param size A non-negative whole numeric vector of the number of trials.
-#' @param prob A numeric vector of values between 0 and 1 of the probability of success.
-#' @param lambda A non-negative numeric vector of means.
-#' @param theta A non-negative numeric vector of the dispersion for the mixture models (student, gamma-Poisson and beta-binomial).
-#' @param shape A non-negative numeric vector of shape.
-#' @param rate A non-negative numeric vector of rate.
-#' @param type A string of the residual type. 'raw' for raw residuals 'dev' for deviance residuals and 'data' for the data.
+#' @param n A non-negative whole number of the number of random samples to
+#'   generate.
 #' @param na_rm A flag specifying whether to remove missing values.
-#' @param threshold A number of the threshold value.
-#' @param simulate A flag specifying whether to simulate residuals.
-#' @param log A flag specifying whether to return the log-transformed value.
-#' @param lower.tail A flag specifying whether to return the lower or upper tail of the distribution.
-#' @param q A vector of quantiles.
+#' @param nas A flag specifying whether to also fill missing values.
 #' @param p A vector of probabilities.
-#' @param sd_mult A non-negative multiplier on the standard deviation of the distribution.
-#' @param alpha The first shape parameter of the Beta distribution.
-#' @param beta The second shape parameter of the Beta distribution.
-#' @keywords internal
+#' @param prob A numeric vector of values between 0 and 1 of the probability of
+#'   success.
+#' @param q A vector of quantiles.
+#' @param rate A non-negative numeric vector of rate.
+#' @param res A flag specifying whether to return the deviance residual as
+#'   opposed to the deviance.
+#' @param sd A non-negative numeric vector of the standard deviations.
+#' @param sd_mult A non-negative multiplier on the standard deviation of the
+#'   distribution.
+#' @param sdlog A non-negative numeric vector of the standard deviations on the
+#'   log scale.
+#' @param shape A non-negative numeric vector of shape.
+#' @param simulate A flag specifying whether to simulate residuals.
+#' @param size A non-negative whole numeric vector of the number of trials.
+#' @param theta A non-negative numeric vector of the dispersion for the mixture
+#'   models (student, gamma-Poisson and beta-binomial).
+#' @param threshold A number of the threshold value.
+#' @param type A string of the residual type. 'raw' for raw residuals 'dev' for
+#'   deviance residuals and 'data' for the data.
+#' @param value A scalar of the value to replace values with.
+#' @param x An object.
 #' @aliases parameters arguments args
 #' @usage NULL
 # nocov start

diff --git a/man/bern.Rd b/man/bern.Rd
diff --git a/man/dev_bern.Rd b/man/dev_bern.Rd
diff --git a/man/dev_beta_binom.Rd b/man/dev_beta_binom.Rd
diff --git a/man/dev_binom.Rd b/man/dev_binom.Rd
diff --git a/man/dev_gamma.Rd b/man/dev_gamma.Rd
diff --git a/man/dev_gamma_pois.Rd b/man/dev_gamma_pois.Rd
diff --git a/man/dev_gamma_pois_zi.Rd b/man/dev_gamma_pois_zi.Rd
diff --git a/man/dev_lnorm.Rd b/man/dev_lnorm.Rd
diff --git a/man/dev_neg_binom.Rd b/man/dev_neg_binom.Rd
diff --git a/man/dev_norm.Rd b/man/dev_norm.Rd
diff --git a/man/dev_pois.Rd b/man/dev_pois.Rd
diff --git a/man/dev_pois_zi.Rd b/man/dev_pois_zi.Rd
diff --git a/man/dev_skewnorm.Rd b/man/dev_skewnorm.Rd
diff --git a/man/dev_student.Rd b/man/dev_student.Rd
diff --git a/man/log_lik_bern.Rd b/man/log_lik_bern.Rd
diff --git a/man/log_lik_beta_binom.Rd b/man/log_lik_beta_binom.Rd
diff --git a/man/log_lik_binom.Rd b/man/log_lik_binom.Rd
diff --git a/man/log_lik_gamma_pois.Rd b/man/log_lik_gamma_pois.Rd
diff --git a/man/log_lik_gamma_pois_zi.Rd b/man/log_lik_gamma_pois_zi.Rd
diff --git a/man/log_lik_lnorm.Rd b/man/log_lik_lnorm.Rd
diff --git a/man/log_lik_neg_binom.Rd b/man/log_lik_neg_binom.Rd
diff --git a/man/log_lik_pois_zi.Rd b/man/log_lik_pois_zi.Rd
diff --git a/man/log_lik_student.Rd b/man/log_lik_student.Rd
diff --git a/man/lower.Rd b/man/lower.Rd