R/summarize_sample_vector.R

In michael-franke/aida-package: R package with helper functions for courses on _A_dvanced topics in and _I_ntro to _D_ata _A_nalysis

#' Summarize single vector of samples 
#' 
#' ...and their lower/upper 95\% Credible Interval & mean
#' 
#' @param samples numeric vector of samples
#' @param name the name of the summarized parameter
#' 
#' @return tibble
#' @export
summarize_sample_vector <- function(samples, name = '') {
    tibble(
        Parameter = name,
        '|95%' = HDInterval::hdi(samples)[1],
        mean  = mean(samples),
        '95%|' = HDInterval::hdi(samples)[2]
    )
}