R/report_rma.R

In WillemSleegers/tidystats-v0.3: Create a Tidy Statistics Output File

#' Report method for metafor's rma models
#'
#' Function to report a meta-analysis in APA style.
#'
#' @param identifier A character string identifying the model.
#' @param group A character string identifying the group you want to report the
#' statistics of.
#' @param term A character string indicating which term you want to report the
#' statistics of.
#' @param term_nr A number indicating which term you want to report the the
#' statistics of.
#' @param results A tidystats list.
#'
#' @export
report_rma <- function(identifier, group = NULL, term = NULL, term_nr = NULL,
  results = getOption("tidystats_list")) {

  # Store the arguments in variables that do not share column names with the
  # model data frame
  res_group <- group
  res_term <- term
  res_term_nr <- term_nr

  print("Arguments:")
  print(res_group)
  print(res_term)
  print(res_term_nr)

  # Extract the results of the specific model through its identifier
  res <- results[[identifier]]

  # Filter the results based on the supplied information
  if (!is.null(group)) {
    res <- dplyr::filter(res, group == res_group)
  }
  if (!is.null(term)) {
    res <- dplyr::filter(res, term == res_term)
  }
  if (!is.null(term_nr)) {
    res <- dplyr::filter(res, term_nr == res_term_nr)
  }
  if (!is.null(statistic)) {
    res <- dplyr::filter(res, statistic == res_statistic)
  }

  print(res)

    if (res$group[1] == "heterogeneity") {
      # TODO
      output <- "TODO"
    } else if (res$group[1] == "moderators") {
      # TODO
      output <- "TODO"
    } else {
      b <- format(res$value[res$statistic == "b"], digits = 2, nsmall = 2)
      SE <- format(res$value[res$statistic == "SE"], digits = 2, nsmall = 2)

      output <- paste0("*b* = ", b, ", *SE* = ", SE)

      if ("z" %in% res$statistic) {
        z <- format(res$value[res$statistic == "z"], digits = 2, nsmall = 2)
        output <- paste0(output, ", *z* = ", z)
      } else {
        t <- format(res$value[res$statistic == "t"], digits = 2, nsmall = 2)
        output <- paste0(output, ", *t* = ", t)
      }

      p = report_p_value(res$value[res$statistic == "p"])
      output <- paste0(output, ", ", p)

      res_CI <- dplyr::filter(res, stringr::str_detect(statistic, "[0-9]+% CI"))

      CI_pct <- as.numeric(stringr::str_extract(res_CI$statistic, "[0-9]+"))
      CI_pct <- CI_pct[2] - CI_pct[1]

      CI_value1 <- format(res_CI$value[1], nsmall = 2, digits = 2)
      CI_value2 <- format(res_CI$value[2], nsmall = 2, digits = 2)

      CI <- paste0(CI_pct, "% CI ", "[", CI_value1, ", ", CI_value2, "]")
      output <- paste0(output, ", ", CI)
    }


  return(output)
}