R/print.mln.mean.sd.R

In stmcg/estmeansd: Estimating the Sample Mean and Standard Deviation from Commonly Reported Quantiles in Meta-Analysis

#' Print method for objects of class "mln.mean.sd"
#'
#' Print method for objects of class "mln.mean.sd".
#'
#' @param x object of class "mln.mean.sd".
#' @param ... other arguments.
#' @return No value is returned.
#' @seealso \code{\link{mln.mean.sd}}
#' @examples
#' ## Generate S2 summary data
#' set.seed(1)
#' n <- 100
#' x <- stats::rlnorm(n, 2.5, 1)
#' quants <- stats::quantile(x, probs = c(0.25, 0.5, 0.75))
#' obs.mean <- mean(x)
#' obs.sd <- stats::sd(x)
#'
#' ## Estimate the sample mean and standard deviation using the BC method
#' res <- mln.mean.sd(q1.val = quants[1], med.val = quants[2],
#'     q3.val = quants[3], n = n)
#' print(res)
#'
#' @export

## S3 method for class 'bc.mean.sd'
print.mln.mean.sd <- function(x, ...) {
  cat("$est.mean\n")
  print(x$est.mean)
  cat("\n$est.sd\n")
  print(x$est.sd)
}