using sides arg on xlim and ylim too

Author: Jordan S Read

R/access-gsplot.R

@@ -5,33 +5,42 @@
 #' get the xlim for views in gsplot object
 #' 
 #' @param object a gsplot object
+#' @param side which side(s) to use
 #' 
 #' @export
-xlim <- function(object) UseMethod("xlim")
+xlim <- function(object, side) UseMethod("xlim")
 
 #' @export
-xlim.gsplot <- function(object){
+xlim.gsplot <- function(object, side=NULL){
 
-  names = unname(sapply(views(object), function(x) paste0('side.',x$window$side[1])))
-  lapply(views(object), function(x) x$window$xlim) %>% 
-    setNames(names)
+  if (!is.null(side))
+    views <- object[views_with_side(views(object), side)]
+  else 
+    views <- views(object)
+  names = unname(sapply(views, function(x) paste0('side.',x$window$side[1])))
+  unique(lapply(views, function(x) x$window$xlim)) %>% 
+    setNames(unique(names))
 }
 
 #' ylim for gsplot
 #' 
 #' get the ylim for views in gsplot object
 #' 
 #' @param object a gsplot object
+#' @param side which side(s) to use
 #' 
 #' @export
-ylim <- function(object) UseMethod("ylim")
+ylim <- function(object, side) UseMethod("ylim")
 
 #' @export
-ylim.gsplot <- function(object){
-  
-  names = unname(sapply(views(object), function(x) paste0('side.',x$window$side[2])))
-  lapply(views(object), function(x) x$window$ylim) %>% 
-    setNames(names)
+ylim.gsplot <- function(object, side=NULL){
+  if (!is.null(side))
+    views <- object[views_with_side(views(object), side)]
+  else 
+    views <- views(object)
+  names = unname(sapply(views, function(x) paste0('side.',x$window$side[2])))
+  unique(lapply(views, function(x) x$window$ylim)) %>% 
+    setNames(unique(names))
 }
 
 #' log for gsplot

man/xlim.Rd

@@ -4,10 +4,12 @@
 \alias{xlim}
 \title{xlim for gsplot}
 \usage{
-xlim(object)
+xlim(object, side)
 }
 \arguments{
 \item{object}{a gsplot object}
+
+\item{side}{which side(s) to use}
 }
 \description{
 get the xlim for views in gsplot object

man/ylim.Rd

@@ -4,10 +4,12 @@
 \alias{ylim}
 \title{ylim for gsplot}
 \usage{
-ylim(object)
+ylim(object, side)
 }
 \arguments{
 \item{object}{a gsplot object}
+
+\item{side}{which side(s) to use}
 }
 \description{
 get the ylim for views in gsplot object

tests/testthat/test-access_gsplot.R

@@ -30,7 +30,8 @@ test_that("xlim for string input", {
     points(x=3:10,y=4:11, side=c(1,2))
 
   expect_equal(xlim(usrDef)[['side.3']], c(1,1))
-  expect_equal(xlim(usrDef)[['side.1']], c(3,10))
+  expect_equal(xlim(usrDef, side = 3)[[1]], c(1,1))
+  expect_equal(xlim(usrDef, side = 1)[[1]], c(3,10))
 
 })