R/remove_axis.R

In lmgibson/cplthemes: Custom ggplot theme and table styling for the California Policy Lab

#' CPL [ggplot2] theme
#'
#' Removes axes and axes' labels
#'
#' @param axis Axis to drop. [str]: "x", "y", or "both"
#' @param flip Is [coord_flip()] used? [logical]: TRUE/FALSE
#'
#' @md
#' @export
remove_axis <- function(axis = "y", flip = FALSE) {

    if (axis == "x" && flip == FALSE) {

        ggplot2::theme(axis.text.x = ggplot2::element_blank(),
                       axis.line.x = ggplot2::element_blank())

    } else if (axis == "x" && flip == TRUE) {

        ggplot2::theme(axis.text.x = ggplot2::element_blank(),
                       axis.line.x = ggplot2::element_blank(),
                       axis.ticks = ggplot2::element_blank(),
                       axis.line.y = ggplot2::element_line(colour = NULL,
                                                           size = NULL,
                                                           linetype = NULL,
                                                           lineend = NULL))

    } else if (axis == "y" && flip == FALSE) {

        ggplot2::theme(axis.text.y = ggplot2::element_blank(),
                       axis.line.y = ggplot2::element_blank(),
                       axis.ticks = ggplot2::element_blank())

    } else if (axis == "y" && flip == TRUE) {

        ggplot2::theme(axis.text.y = ggplot2::element_blank(),
                       axis.line.y = ggplot2::element_blank(),
                       axis.ticks = ggplot2::element_blank(),
                       axis.title.y = ggplot2::element_blank())

    } else if (axis == "both") {

        ggplot2::theme(axis.text.x = ggplot2::element_blank(),
                       axis.line.x = ggplot2::element_blank(),
                       panel.grid.major.y = ggplot2::element_blank(),
                       axis.text.y = ggplot2::element_blank(),
                       axis.line.y = ggplot2::element_blank(),
                       axis.ticks = ggplot2::element_blank())

    } else {

        stop('Invalid "axis" or "flip" argument. Valid arguments are: ',
             '"x", "y", and "both", or TRUE/FALSE',
             call. = FALSE)
    }
}