R/params.R

In extras: Helper Functions for Bayesian Analyses

#' Parameter Descriptions
#'
#' Default parameter descriptions which may be overridden in individual
#' functions.
#'
#' A flag is a non-missing logical scalar.
#'
#' A string is a non-missing character scalar.
#'
#' @keywords internal
#' @name params
#' @param ... Other arguments passed to methods.
#' @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 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 meanlog A numeric vector of the means on the log scale.
#' @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 nas A flag specifying whether to also fill missing values.
#' @param p A vector of probabilities.
#' @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
#' @export
# nocov start
params <- function(...) NULL
# nocov end