logged w/ sides=c(1,2) args (optional) #246

Author: Jordan S Read

NAMESPACE

@@ -1,7 +1,7 @@
 # Generated by roxygen2 (4.1.1): do not edit by hand
 
 S3method(gsplot,default)
-S3method(log,gsplot)
+S3method(logged,gsplot)
 S3method(print,gsplot)
 S3method(xlim,gsplot)
 S3method(ylim,gsplot)
@@ -22,7 +22,7 @@ export(is.gsplot)
 export(legend)
 export(lines)
 export(loadConfig)
-export(log)
+export(logged)
 export(mtext)
 export(par)
 export(points)

R/access-gsplot.R

@@ -38,26 +38,29 @@ ylim.gsplot <- function(object){
 #' 
 #' get the log for views in gsplot object
 #' 
-#' @aliases log
-#' @name log
-#' @rdname log
+#' @name logged
 #' @param object a gsplot object
 #' @param side which side(s) to use (returns logical)
 #' @export
-log <- function(object, side) {
-  if (is.gsplot(object))
-    UseMethod('log')
-  base::log(x=object, base=side)  
-}
+logged <- function(object, side) UseMethod('logged')
 
+#' @rdname logged
 #' @export
-log.gsplot <- function(x, side=NULL){
-  names = unname(sapply(views(x), function(x) paste0('side.',paste(x$window$side[1:2],collapse='.'))))
-  logs = lapply(views(x), function(x) x$window$log) %>% 
-    setNames(names)
+logged.gsplot <- function(object, side=NULL){
 
+  is.logged <- function(window, side){
+    log = window$log
+    if (side %% 2 == 0){ # is y
+      grepl(pattern = 'y',log)
+    } else {
+      grepl(pattern = 'x',log)
+    }
+  }
   if (!is.null(side)){
-    warning('not yet implemented. Will return boolean for side matches')
+    sapply(side, function(x) is.logged(object[[views_with_side(views(object), side=x)[1]]]$window, x))
+  } else {
+    names = unname(sapply(views(object), function(x) paste0('side.',paste(x$window$side[1:2],collapse='.'))))
+    lapply(views(object), function(x) x$window$log) %>% 
+      setNames(names)
   }
-  return(logs)
 }

man/log.Rd man/logged.Rdman/log.Rd renamed to man/logged.Rd

@@ -1,10 +1,13 @@
 % Generated by roxygen2 (4.1.1): do not edit by hand
 % Please edit documentation in R/access-gsplot.R
-\name{log}
-\alias{log}
+\name{logged}
+\alias{logged}
+\alias{logged.gsplot}
 \title{log for gsplot}
 \usage{
-log(object, side)
+logged(object, side)
+
+\method{logged}{gsplot}(object, side = NULL)
 }
 \arguments{
 \item{object}{a gsplot object}

tests/testthat/test-access_gsplot.R

@@ -41,21 +41,29 @@ test_that("par for simple object",{
   expect_is(par(gsplot(mar=c(4,4,4,4), xaxs='r', yaxs='r')), 'list')
 })
 
-context("test get log for gsplot object")
+context("test get logged for gsplot object")
 
-test_that("log for simple object",{
+test_that("logged for simple object",{
   usrDef <- gsplot(mar=c(4,4,4,4), xaxs='r', yaxs='r') %>% 
     points(x=1, y=2, side=c(3,2), legend.name="Points 1", cex=3, xlab='cat') %>% 
     points(x=3:10,y=4:11, side=c(1,2))
-  expect_equal(log(usrDef)[[1]],"")
-  expect_equal(log(usrDef)[[2]],"")
+  expect_equal(logged(usrDef)[[1]],"")
+  expect_equal(logged(usrDef)[[2]],"")
 
   usrDef <- lines(usrDef,1:2,4:5, log='xy')
-  expect_equal(log(usrDef)[[1]],"")
-  expect_equal(log(usrDef)[[2]],"xy")
+  expect_equal(logged(usrDef)[[1]],"")
+  expect_equal(logged(usrDef)[[2]],"xy")
 
 })
 
-test_that("base::log still works as expected",{
-  expect_equal(log(10),base::log(10))
-})
+test_that("logged side extractor ",{
+  usrDef <- gsplot(mar=c(4,4,4,4), xaxs='r', yaxs='r') %>% 
+    points(x=1, y=2, side=c(3,2), legend.name="Points 1", cex=3, xlab='cat',log='y') %>% 
+    points(x=3:10,y=4:11, side=c(1,2), log='xy')
+  expect_true(logged(usrDef, side=1))
+  expect_false(logged(usrDef, side=3))
+  
+  dual = logged(usrDef, side=c(1,2))
+  expect_equal(length(dual), 2)
+  expect_true(all(dual))
+})