R/summary.diagmeta.R

Defines functions summary.diagmeta

Documented in summary.diagmeta

#' Summary method for diagmeta
#' 
#' @description
#' Summary method for objects of class \code{diagmeta}.
#' 
#' @param object An object of class \code{diagmeta}.
#' @param \dots Additional arguments.
#'
#' @return
#' A list with classes 'summary.diagmeta' and 'diagmeta' is
#' returned. The list elements are identical to a
#' \code{\link{diagmeta}} object.
#' 
#' @author
#' Srinath Kolampally \email{kolampal@@imbi.uni-freiburg.de},
#' Guido Schwarzer \email{guido.schwarzer@@uniklinik-freiburg.de}
#' 
#' @seealso \code{\link{diagmeta}}
#' 
#' @examples
#' # FENO dataset
#' #
#' data(Schneider2017)
#' 
#' diag1 <- diagmeta(tpos, fpos, tneg, fneg, cutpoint,
#'                   studlab = paste(author, year, group),
#'                   data = Schneider2017,
#'                   log.cutoff = TRUE)
#' 
#' summary(diag1)
#'
#' @method summary diagmeta
#' @export
#' @export summary.diagmeta


summary.diagmeta <- function(object, ...) {
  
  chkclass(object, "diagmeta")
  
  res <- object
  ##
  class(res) <- c("summary.diagmeta", "diagmeta")
  
  res
}
guido-s/diagmeta documentation built on April 9, 2023, 2:35 p.m.