v0.10.1

Author: neilstats

DESCRIPTION

@@ -3,7 +3,7 @@ Title: Create CKB Plots
 Description: ckbplotr provides functions to help create and style plots in R.
     It is being developed by, and primarily for, China Kadoorie Biobank 
     researchers.
-Version: 0.10.0
+Version: 0.10.1
 Authors@R: 
     person(given = "Neil",
            family = "Wright",

NEWS.md

@@ -1,3 +1,7 @@
+# ckbplotr 0.10.1
+
+* Fix xlab and column headings when xlim is a list in forest_plot().
+
 # ckbplotr 0.10.0
 
 * Added ggpreview() and preview argument in save_figure().

R/forest-plot-list-xlim.R

@@ -5,6 +5,9 @@ forest_plot_list_xlim <- function(call){
   xlim <- eval(call$xlim)
   xticks <- eval(call$xticks)
   panels <- eval(call$panels)
+  xlab <- eval(call$xlab)
+  col.left.heading <- eval(call$col.left.heading)
+  col.right.heading <- eval(call$col.right.heading)
 
   ## check arguments
   if (!is.list(xlim) | !is.list(xticks) | !is.list(panels)){
@@ -14,6 +17,19 @@ forest_plot_list_xlim <- function(call){
     rlang::abort("panels, xlim and xticks must be lists of the same length")
   }
 
+  ## make lists
+  xlab <- as.list(xlab)
+  if (length(xlab) < length(xlim)){
+    xlab <- rep(xlab, length(xlim))
+  }
+  if (!is.list(col.left.heading)){
+    col.left.heading <- rep(list(col.left.heading), length(xlim))
+  }
+  if (!is.list(col.right.heading)){
+    col.right.heading <- rep(list(col.right.heading), length(xlim))
+  }
+
+
   ## create arguments for plot.margin and mid.space
   plot.margin <- eval(call$plot.margin)
   if (is.null(plot.margin)){
@@ -39,6 +55,16 @@ forest_plot_list_xlim <- function(call){
                         plot.margin = plot_margin,
                         quiet = TRUE)
 
+    if (!is.null(xlab[i]) && length(xlab) > 0){
+      update_args$xlab <- xlab[[i]]
+    }
+    if (!is.null(col.left.heading[i])){
+      update_args$col.left.heading <- col.left.heading[[i]]
+    }
+    if (!is.null(col.right.heading[i])){
+      update_args$col.right.heading <- col.right.heading[[i]]
+    }
+
     forest <- do.call("forest_plot",
                       utils::modifyList(call, update_args))
 

R/forest-plot.R

@@ -126,7 +126,7 @@ forest_plot <- function(
     col.right          = NULL,
     col.right.parse    = FALSE,
     col.left.heading   = "",
-    col.right.heading  = xlab,
+    col.right.heading  = as.list(xlab),
     col.left.pos       = NULL,
     col.right.pos      = NULL,
     col.left.hjust     = 1,

man/forest_plot.Rd

@@ -261,7 +261,10 @@ forest <- forest_plot(split(my_resultsAB, ~ analysis),
                       xlim = list(c(0.5, 3 + 1e-10),
                                   c(0.1, 4)),
                       xticks = list(c(0.5, 1, 2, 3),
-                                    c(0.1, 1, 2, 4)))
+                                    c(0.1, 1, 2, 4)),
+                      xlab = c("Hazard Ratio (95% CI)", "Odds Ratio (95% CI)"),
+                      col.right.heading = list("HR (95% CI)", "OR (95% CI)"))
+grid::grid.newpage()
 grid::grid.draw(forest$figure)
 ```