R/my_occu_bar_plot_func.R

In rjlopez2/AnlysisOfWaves: Make the Analysis of Ca2+ waves

#' my_occu_bar_plot_func
#'
#' bar plot of waves occurrence
#'
#' @param my_dataset A dataframe with raw data of waves.
#' @param my_var A character string of length 1. The name of the variable you want to make the barplot. This should be wave occurrence or something similar. Default to `"value"`.
#' @param reffer_wave_thres A double. Reference value in seconds indicating the threshold for the calculus of cumulative waves occurrence. Default to 10.
#' @param line_size Integer. the size of the lines to display. Default to 1.
#' @param ... additional parameter to be passed to the aesthetic function \code{pptx_presentation_theme_func()}
#'
#' @return A ggplot object with barplot of waves occurrence in the different animals groups.
#' @export
#'
#' @examples # The example is still missing...
my_occu_bar_plot_func <- function(my_dataset,
                                  my_var = "value",
                                  reffer_wave_thres = 10,
                                  line_size = 1,
                                  ...){

  attempt::stop_if(missing(my_var), msg = "No argument provided for `my_var`. You must provide a target variable to make the plot.")
  attempt::stop_if(!is.character(my_var), msg = "No valid value for argument `my_var`. You must provide a value of type `character`.")
  attempt::stop_if(length(my_var) > 1, msg = "You must provide a single variable name to make the plot.")

  my_var <- sym(my_var)
  my_bar_plot <- my_dataset %>%
    mutate(new_waves = if_else(!!my_var <= reffer_wave_thres & !is.na(!!my_var) & !!my_var > 0,
    # mutate(new_waves = if_else(.data$my_var <= reffer_wave_thres & !is.na(.data$my_var) & .data$my_var > 0,
                               T, F)) %>%
    group_by(.data$Animal, .data$Condition, .data$new_waves) %>%
    select(.data$Animal, .data$Condition, .data$new_waves) %>%
    summarise(count = n()) %>%
    # View
    mutate(Percentage = count/sum(count) * 100) %>%
    filter(.data$new_waves == T) %>%
    # View
    ggplot2::ggplot(ggplot2::aes(x = .data$Animal,
                                 y = .data$Percentage,
                                 fill = .data$new_waves,
                                 alpha = 0.5))  +
    ggplot2::geom_bar(stat="identity",
                      color = "black",
                      ggplot2::aes(fill = .data$Animal),
                      size = line_size) +
    ggplot2::facet_grid(. ~ .data$Condition) +
    ggplot2::scale_y_continuous(limits = c(0, 100)) +
    pptx_presentation_theme_func(...) +
    ggplot2::scale_fill_manual(values = c("#666666", "#CC0000")) +
    ggplot2::labs(x = "Animal", y = "Wave occurrence (%)") + # Add legend
    ggplot2::theme(legend.position = "none")

  # my_bar_plot

  return(occu_bar_plot = my_bar_plot)


}