R/utils.R

In maximilian-heeg/ggsimplestats: Add statistics to ggplots

#' Helper function to formats the results of PMCMRPlus
#'
#'
#' @param res Result from a test from formatPMCMRPlusResults
#' @param y the y position of the bracket
#'
#' @return A tibble
#' @importFrom rlang .data
#' @noRd
formatPMCMRPlusResults <- function(res, y) {
  res <- res$p.value %>%
    as.table() %>%
    as.data.frame() %>%
    # rename colums for use in ggplot
    dplyr::select(
      x = .data$Var1,
      xend = .data$Var2,
      p = .data$Freq
    ) %>%
    dplyr::mutate(
      y = y,
      x = as.numeric(as.character(.data$x)),
      xend = as.numeric(as.character(.data$xend))
    ) %>%
    dplyr::filter(!is.na(.data$p))
  return(res)
}


#' Helper function to formats the the pvalues in geomStat
#'
#'
#' @param data data.frame
#' @param step.increase Increse betweeen the different brackets
#' @param hide.ns Remove insignificant values
#'
#' @return data.frame
#' @noRd
formatPValues <- function(data, step.increase = 0.05, hide.ns = TRUE) {
  if (hide.ns) {
    data <- data[data$p < 0.05, ]
  }

  data <- data %>%
    dplyr::group_by(.data$PANEL) %>%
    ## create a y max that is a little higher than needed to expand the scales
    dplyr::mutate(ymax = .data$y + .data$range * step.increase * (dplyr::row_number()+1))

  return(data)
}


#' Helper function to adjust the y position
#'
#'
#' @param data data.frame
#' @param step.increase Increse betweeen the different brackets
#'
#' @return data.frame
#' @noRd
adjustYPosition <- function(data, step.increase) {

  data <- data %>%
    dplyr::group_by(.data$PANEL) %>%
    dplyr::mutate(y = .data$y + step.increase * dplyr::row_number())

  return(data)
}