R/forest.find.outliers.R

In MathiasHarrer/dmetar: Companion R Package for the Guide 'Doing Meta-Analysis in R'

#' Print, summary and plot methods for objects created using 'dmetar' functions
#'
#' Print, summary and plot S3 methods for objects of class \code{direct.evidence.plot}, \code{find.outliers},
#' \code{influence.analysis}, \code{multimodel.inference}, \code{pcurve}, \code{power.analysis},
#' \code{subgroup.analysis.mixed.effects}, and \code{sucra}.
#'
#' @param x An object of class \code{find.outliers}.
#' @param ... Other arguments of the \code{meta.forest} or \code{metafor}'s code{\link[metafor]{forest}}
#' function. Can be used for styling the generated forest plot.
#'
#' @details
#' A total of four package-specific S3 methods are provided in \code{dmetar}: S3 methods for \code{print},
#' \code{summary}, \code{plot} and \code{forest}. Outputs from \code{print} and \code{summary} are always identical.
#' When both \code{plot} and \code{forest} are available for a class, outputs of both functions are identical (i.e., a forest
#' plot is returned). The \code{forest}/\code{plot} function allows additional arguments of the \code{meta.forest} or
#' \code{metafor}'s code{\link[metafor]{forest}} function (depending on the class of the meta-analysis object on which prior
#' calculations are based on). These can be used for further styling of the forest plot.
#'
#' @author Mathias Harrer & David Daniel Ebert
#'
#'
#' @importFrom stats as.formula hat influence ks.test optimize pbinom pchisq pf pnorm pt punif qchisq qf qnorm qt reformulate reorder setNames uniroot
#' @importFrom meta forest
#' @importFrom metafor forest.rma
#'
#' @method forest find.outliers
#' @export
#' @export forest.find.outliers

forest.find.outliers = function(x, ...){

  # meta
  if (!(class(x)[2] %in% c("mf", "mf.null"))){

    if (class(x)[2] == "ftrf" | class(x)[2] == "null.ftrf"){meta::forest(x$m.fixed, ...)}
    if (class(x)[2] == "ffrt" | class(x)[2] == "null.ffrt"){meta::forest(x$m.random, ...)}
    if (class(x)[2] == "ftrt" | class(x)[2] == "null.ftrt"){meta::forest(x$m.fixed, ...)
      meta::forest(x$m.random, ...)}

  } else {

    # metafor
    metafor::forest.rma(x$m, addcred = T, showweights = T, ...)

  }

}