R/rvn_theme_RavenR.R

In RavenR: Raven Hydrological Modelling Framework R Support and Analysis

#' @title RavenR ggplot theme
#'
#' @description
#' Makes the general Raven R Theme for all ggplots
#'
#' @details
#' Sets up the default theme for all ggplots generated using a
#' built in Raven R function. Made by adjusting the built in \code{theme_bw}.
#'
#' @return returns a theme for use in ggplot2 figures
#'
#' @seealso \code{\link{rvn_annual_volume}} to create a scatterplot of annual flow
#' volumes.
#'
#' @examples
#' # generate a basic ggplot and apply the RavenR theme
#' library(ggplot2)
#' ggplot(data=cars, aes(x=speed, y=dist))+
#' geom_point()+
#' rvn_theme_RavenR()
#'
#' @export rvn_theme_RavenR
#' @importFrom ggplot2 theme theme_bw element_rect element_blank
rvn_theme_RavenR <- function()
{
  theme_bw() +
    theme(panel.border = element_rect(color = "black"),
          legend.title = element_blank())
    # theme(axis.title = element_text(face = 'bold'))
}