add xlimits argument to ssd_plot to set x-axis limits (passed to scal…

…e_x_continuous(limits))

R/params.R

@@ -119,6 +119,10 @@
 #'   - `NULL` for no breaks
 #'   - `waiver()` for the default breaks
 #'   - A numeric vector of positions
+#' @param xlimits The x-axis limits as one of:
+#'   - `NULL` to use the default scale range
+#'   - A numeric vector of length two providing the limits. 
+#'   Use NA to refer to the existing minimum or maximum limits.
 #' @param xintercept The x-value for the intersect
 #' @param xlab A string of the x-axis label.
 #' @param yintercept The y-value for the intersect.

R/ssd-plot.R

@@ -18,7 +18,7 @@
 #' @export
 ggplot2::waiver
 
-plot_coord_scale <- function(data, xlab, ylab, trans, big.mark, suffix, xbreaks = waiver()) {
+plot_coord_scale <- function(data, xlab, ylab, trans, big.mark, suffix, xbreaks = waiver(), xlimits = NULL) {
   chk_string(xlab)
   chk_string(ylab)
 
@@ -30,7 +30,8 @@ plot_coord_scale <- function(data, xlab, ylab, trans, big.mark, suffix, xbreaks
     coord_trans(x = trans),
     scale_x_continuous(xlab,
       breaks = xbreaks,
-      labels = ssd_label_comma(big.mark = big.mark)
+      labels = ssd_label_comma(big.mark = big.mark), 
+      limits = xlimits
     ),
     scale_y_continuous(ylab,
       labels = label_percent(suffix = suffix), limits = c(0, 1),
@@ -57,7 +58,8 @@ ssd_plot <- function(data, pred, left = "Conc", right = left, ...,
                      shift_x = 3, add_x = 0,
                      bounds = c(left = 1, right = 1),
                      big.mark = ",", suffix = "%",
-                     trans = "log10", xbreaks = waiver()) {
+                     trans = "log10", xbreaks = waiver(),
+                     xlimits = NULL) {
   .chk_data(data, left, right, weight = NULL, missing = TRUE)
   chk_unused(...)
   chk_null_or(label, vld = vld_string)
@@ -162,7 +164,7 @@ ssd_plot <- function(data, pred, left = "Conc", right = left, ...,
 
   gp <- gp + plot_coord_scale(data,
     xlab = xlab, ylab = ylab, big.mark = big.mark, suffix = suffix,
-    trans = trans, xbreaks = xbreaks
+    trans = trans, xbreaks = xbreaks, xlimits = xlimits
   )
 
   if (!is.null(label)) {

tests/testthat/test-ssd-plot.R

@@ -68,3 +68,8 @@ test_that("ssd_plot fills in missing order", {
     "missing_order"
   )
 })
+
+test_that("ssd_plot xlims", {
+  expect_snapshot_plot(ssd_plot(ssddata::ccme_boron, boron_pred, xlimits = c(NA, 10000)), "boron_limits")
+})
+