R/axis0.R

In trinker/plotflow: Tools to Speed Up Workflow Associated with Plotting

#' Adjust Space Between Axis in ggplot2
#'
#' \code{axis0} - Adjust Space Between x/y Axis in ggplot2.
#'
#' @param max The upper/right-most edge (upper ylim/xlim numeric value).
#' @param scale A ggplot scale type (e.g. "continuous", "discrete", etc.)
#' @param axis The axis to operate on ("x" or "y").
#' @references \url{http://stackoverflow.com/a/20220737/1000343}.
#' @seealso \code{\link[ggplot2]{scale_y_continuous}}
#' @export
#' @rdname axis0
#' @examples
#' \dontrun{
#' ggplot(reorder_by(cyl, ~-cyl , mtcars, length), aes(x=as.factor(cyl))) +
#'     geom_bar()  +
#'     theme_apa() +
#'     y0(cushion(as.factor(mtcars$cyl))) +
#'     xlab("Cylinders") +
#'     ylab("Total")
#'
#' library(dplyr)
#' mtcars2 <- mtcars %>% group_by(cyl) %>% summarise(n=length(cyl))
#' ggplot(mtcars2, aes(y=as.factor(cyl), x=n)) +
#'     geom_point()  +
#'     theme_apa() +
#'     x0(16)
#'
#' ggplot(mtcars, aes(x=hp, y=mpg)) +
#'   geom_point()  +
#'   theme_apa() +
#'   x0(max(mtcars$hp) + 10) +
#'   y0(max(mtcars$mpg) + 5)
#' }
axis0 <- function(max, scale = "continuous", axis = "y") {

    fun <- match.fun(sprintf("scale_%s_%s", axis, scale))
    fun(expand = c(0,0), limits = c(0, max))

}

#' Adjust Space Between Axis in ggplot2
#'
#' \code{x0} - Adjust Space Between x Axis in ggplot2.
#'
#' @export
#' @rdname axis0
x0 <- function(max, scale = "continuous") {

    axis0(max, scale = scale, axis = "x")

}

#' Adjust Space Between Axis in ggplot2
#'
#' \code{y0} - Adjust Space Between y Axis in ggplot2.
#'
#' @export
#' @rdname axis0
y0 <- function(max, scale = "continuous") {

    axis0(max, scale = scale, axis = "y")

}