Nothing
#' @title Distribution summary
#' @description Summarize a numerical distribution.
#'
#' @param x vector of numerical values.
#' @param p percent of distribution to summarized by quantile interval (ci) and
#' highest posterior density interval (hdi).
#' @param ... arguments passed to \code{\link[modeest]{mlv}} to estimate the
#' mode if \code{use.mlv} is \code{TRUE}.
#'
#' @author Eric Archer \email{eric.archer@@noaa.gov}
#'
#' @export
#'
distSmry <- function(x, p = 0.95, ...) {
x <- as.numeric(x)
num.NA = sum(is.na(x))
x <- stats::na.omit(x)
if(length(x) == 0) stop("'x' has no non-NA values.")
if(!isBetween(p, 0, 100, include.ends = TRUE)) {
stop("'p' must be between 0 and 100.")
}
n <- length(x)
if(p > 1) p <- p / 100
lci <- (1 - p) / 2
uci <- 1 - lci
quant.x <- unname(stats::quantile(x, p = c(lci, uci)))
hdi.x <- unname(HDInterval::hdi(x, credMass = p))
c(
n = n,
num.NA = num.NA,
mean = mean(x),
median = median(x),
mode = modeest::mlv(x, ...),
min = min(x),
max = max(x),
sd = stats::sd(x),
ci.lower = quant.x[1],
ci.upper = quant.x[2],
hdi.lower = hdi.x[1],
hdi.upper = hdi.x[2]
)
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.