R/pureCumulForest.R

In leibniz-psychology/PsychOpen-CAMA-R-package: psychopencama.zpid.de

#' @title cumulative Forest plot
#' @description
#' Using metafor rma.uni function to fit a meta-analytic multivariate/multilevel fixed- and random/mixed-effects model for the given dataset.
#' The model then is used as input for the metaviz viz_forest function to print a forrest plot
#' See Documentation of metafor and metaviz packages for details.
#' @param measure
#' A character string indicating underlying summary measure.
#' @return
#' creates a cumulative forest plot
#' also creates a json file (imgHeight.json) that is used in a later api call to define the height of the plots
#' @author Robert Studtrucker
#' @export
pureCumulForest <- function(rma_model,measure,d,effectName="Effect") {
  #load needed dependencies
  #library('metafor')
  #library("ggplot2")
  #library("metaviz")
  #library('jsonlite')

  requireNamespace("metafor")
  requireNamespace("ggplot2")
  requireNamespace("metaviz")
  requireNamespace("jsonlite")

  #load the in variable d defined dataset from the package
  dat<-get(d)

  #load the in variable d defined dataset from the package
  dat <- checkData(d)

  # depending on the given measure we have to transform the labels of the x axis (Fisher's z values back to correlation coefficients using tanh)
  if(measure == "COR") {

    #fitting the rma.uni model based on z transformed data
    #tmp<-metafor::cumul(rma_model, order=order(dat$r_year))

    #creating a cumulative forest plot based on the fitted rma.uni model
    fp <- metaviz::viz_forest(x = rma_model,
                     variant = "classic",
                     study_labels = rma_model$slab,
                     text_size =4,
                     xlab = effectName,
                     annotate_CI = TRUE,
                     x_trans_function = tanh,
                     type = "cumulative")

  }else{

    tmp<-metafor::cumul(rma_model, order=order(dat$r_year))

    #creating a cumulative forest plot based on the fitted rma.uni model
    fp <- metaviz::viz_forest(x = rma_model,
                     variant = "classic",
                     study_labels = tmp$slab,
                     text_size =4,
                     xlab = effectName,
                     annotate_CI = TRUE,
                     type = "cumulative")
  }

  # creating a json object with information about the height of the plot
  # this information is needed by the web service to define how big the requested image has to be.
  # If not specified standard height and wde is used wich may cause deformed plots when there are a lot of rows in the plot.
  height<-list("height" = length(rma_model$yi))
  jsonlite::write_json(height, "imgHeight.json")

  # print the cumul forest plot so the corresponding object can be retrieved by the web service
  print(fp)
  invisible();
  }