base theme for forestploter

DESCRIPTION

@@ -14,6 +14,7 @@ License: GPL (>= 3)
 Depends: 
     R (>= 2.10)
 Imports: 
+    forestploter,
     ggplot2,
     stringr,
     systemfonts,

NAMESPACE

@@ -13,6 +13,8 @@ export(oxford_brewer_palettes)
 export(oxford_fonts)
 export(oxford_theme_palettes)
 export(theme_oxford)
+export(theme_oxford_forest)
+importFrom(forestploter,forest_theme)
 importFrom(ggplot2,element_blank)
 importFrom(ggplot2,element_line)
 importFrom(ggplot2,element_rect)

R/oxford_theme.R

@@ -1,7 +1,7 @@
 #'
-#' A generic/base [ggplot2] theme for the oxthema package
+#' A generic/base [ggplot2[] theme for the oxthema package
 #'
-#' This generic/base [ggplot2] theme is the template from which all other
+#' This generic/base [ggplot2[] theme is the template from which all other
 #' themes in the [oxthema] package is built on. This theme is inspired by
 #' Bob Rudis' [hrbrthemes](https://github.com/hrbrmstr/hrbrthemes) package
 #' drawing heavily on its typography-centric focus. This function uses the

R/oxford_theme_forest.R

@@ -0,0 +1,74 @@
+#'
+#' Oxford theme for [forestploter] package
+#'
+#' @param base_size The size of text
+#' @param base_family The font family to use for the text. Default to
+#'   main Oxford font *Roboto*
+#' @param ci_col Colour of the CI. A vector of colour should be provided for
+#'   the grouped forest plot. Default set to *Oxford blue*
+#' @param ci_fill Colour fill the point estimation. A vector of colour should be
+#'   provided for the grouped forest plot. Default to value of `ci_col`.
+#' @param refline_col Line colour for the reference line. Default set to
+#'   *Oxford sienna*.
+#' @param vertline_col Line colour for the extra vertical line. Default set to
+#'   *Oxford sienna*.
+#' @param summary_col Colour for borders of the summary diamond shape. Default
+#'   set to *Oxford dusk*
+#' @param summary_fill Colour for filling the summary diamond shape. Default set
+#'   to value of `summary_col`.
+#' @param footnote_cex Multiplier applied to font size for footnote.
+#' @param footnote_fontface The font face for footnote.
+#' @param footnote_col Colour of the footnote. Default set to
+#'   *Oxford sage green*.
+#' @param title_col Colour of title. Default set to *Oxford blue*
+#' @param title_fontfamily Font family of title. Default set to value of
+#'   `base_family`.
+#' @param arrow_fill Filling colour of the arrow head. Default set to
+#'   *Oxford blue*.
+#' @param arrow_col Line and text colour of the arrow. Default set to value of
+#'   `arrow_fill`.
+#'
+#' @returns A list of specified theme parameters.
+#'
+#' @examples
+#' theme_oxford_forest()
+#'
+#' @rdname theme_forest
+#' @export
+#'
+theme_oxford_forest <- function(base_size = 11,
+                                base_family = "Roboto",
+                                ci_col = get_oxford_colour("Oxford blue"),
+                                ci_fill = ci_col,
+                                refline_col = get_oxford_colour("red"),
+                                vertline_col = get_oxford_colour("red"),
+                                summary_col = get_oxford_colour("ash"),
+                                summary_fill = summary_col,
+                                footnote_cex = 0.7,
+                                footnote_fontface = "bold",
+                                footnote_col = get_oxford_colour("royal"),
+                                title_col = get_oxford_colour("Oxford blue"),
+                                title_fontfamily = base_family,
+                                arrow_fill = get_oxford_colour("Oxford blue"),
+                                arrow_col = arrow_fill) {
+  forestploter::forest_theme(
+    base_size = base_size,
+    base_family = base_family,
+    ci_col = ci_col,
+    ci_fill = ci_fill,
+    refline_lwd = 1.5,
+    refline_col = refline_col,
+    vertline_col = vertline_col,
+    summary_col = summary_col,
+    summary_fill = summary_fill,
+    footnote_cex = footnote_cex,
+    footnote_fontface = footnote_fontface,
+    footnote_col = footnote_col,
+    title_col = title_col,
+    title_fontfamily = title_fontfamily,
+    arrow_fill = arrow_fill,
+    arrow_col = arrow_col,
+    arrow_lwd = 1.25
+  )
+}
+

R/oxthema.R

@@ -18,5 +18,6 @@
 #' @importFrom systemfonts system_fonts
 #' @importFrom ggplot2 theme margin element_rect element_text element_line
 #'   element_blank
+#' @importFrom forestploter forest_theme
 #'
 "_PACKAGE"

pkgdown/_pkgdown.yml

@@ -30,6 +30,8 @@ navbar:
         href: articles/oxford-palettes.html
       - text: "Oxford Theme"
         href: articles/oxford-theme.html
+      - text: "Add-on Themes"
+        href: articles/addon-themes.html
     twitter:
       icon: "fab fa-twitter fa-lg"
       href: http://twitter.com/OxIHTM
@@ -69,6 +71,10 @@ reference:
     contents:
     - theme_oxford
 
+  - title: Add-on Themes
+    contents:
+    - theme_oxford_forest
+
   - title: Utilities
     contents:
     - cmyk2rgb

vignettes/addon-themes.Rmd

@@ -0,0 +1,68 @@
+---
+title: "Add-on Themes"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{Add-on Themes}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r setup, echo = FALSE}
+library(oxthema)
+library(forestploter)
+library(grid)
+```
+
+## Oxford theme for `forestploter`
+
+```{r fp-data, echo = FALSE}
+dt <- read.csv(system.file("extdata", "example_data.csv", package = "forestploter"))
+
+# Indent the subgroup if there is a number in the placebo column
+dt$Subgroup <- ifelse(is.na(dt$Placebo), 
+                      dt$Subgroup,
+                      paste0("   ", dt$Subgroup))
+
+# NA to blank
+dt$Treatment <- ifelse(is.na(dt$Treatment), "", dt$Treatment)
+dt$Placebo <- ifelse(is.na(dt$Placebo), "", dt$Placebo)
+dt$se <- (log(dt$hi) - log(dt$est))/1.96
+
+# Add a blank column for the forest plot to display CI.
+# Adjust the column width with space. 
+dt$` ` <- paste(rep(" ", 20), collapse = " ")
+
+# Create confidence interval column to display
+dt$`HR (95% CI)` <- ifelse(is.na(dt$se), "",
+                             sprintf("%.2f (%.2f to %.2f)",
+                                     dt$est, dt$low, dt$hi))
+```
+
+```{r fp-theme, fig.align = "center", fig.width = 8, fig.height = 6}
+# Define theme
+tm <- theme_oxford_forest()
+
+p <- forest(dt[,c(1:3, 20:21)],
+            est = dt$est,
+            lower = dt$low, 
+            upper = dt$hi,
+            sizes = dt$se,
+            ci_column = 4,
+            ref_line = 1,
+            arrow_lab = c("Placebo Better", "Treatment Better"),
+            xlim = c(0, 4),
+            ticks_at = c(0.5, 1, 2, 3),
+            footnote = "This footnote is in Oxford ash grey",
+            theme = tm)
+
+# Print plot
+plot(p)
+```
+

vignettes/oxford-theme.Rmd

@@ -19,7 +19,7 @@ library(oxthema)
 library(ggplot2)
 ```
 
-The `oxthema`  package has a generic/base [ggplot2] theme which is the template from which all other themes in the [oxthema] package is built on. This theme is inspired by Bob Rudis' [hrbrthemes](https://github.com/hrbrmstr/hrbrthemes) package drawing heavily on its typography-centric focus. This function uses the *Roboto* Google font which is the core Oxford san serif font. It is freely downloadable and easily installed on any system.
+The `oxthema`  package has a generic/base `ggplot2` theme which is the template from which all other themes in the `oxthema` package is built on. This theme is inspired by Bob Rudis' [hrbrthemes](https://github.com/hrbrmstr/hrbrthemes) package drawing heavily on its typography-centric focus. This function uses the *Roboto* Google font which is the core Oxford san serif font. It is freely downloadable and easily installed on any system.
 
 ## Oxford theme palettes for use in plotting
 
@@ -46,7 +46,7 @@ ggplot(
     x = "Engine shape",
     y = "Counts"
   ) +
-  theme_oxford()
+  theme_oxford(grid = "Y")
 ```
 
 ### Scatter plot
@@ -65,7 +65,7 @@ ggplot(data = mtcars, mapping = aes(x = mpg, y = disp, colour = factor(cyl))) +
     title = "This title is in Oxford Blue",
     subtitle = "This subtitle is in Oxford Ash Grey"
   ) +
-  theme_oxford()
+  theme_oxford(grid = "XY")
 ```
 
 ### Plotting maps using Oxford palettes