Fixes #206

Plenty of improvements could be made.

Author: ldecicco-USGS

NAMESPACE

@@ -3,6 +3,7 @@
 S3method(gsplot,default)
 S3method(logged,gsplot)
 S3method(print,gsplot)
+S3method(summary,gsplot)
 S3method(xlim,gsplot)
 S3method(ylim,gsplot)
 export("%>%")

R/gsplot-class.R

@@ -26,3 +26,35 @@ gsplot.list <- function(x){
   class(x) <- "gsplot"
   invisible(x) 
 }
+
+#' Summary of gsplot object
+#'
+#' Summary information
+#'
+#' @param object list
+#' @param \dots additional parameters
+#' @export
+#' @examples 
+#' gs <- gsplot() %>%
+#'        points(1:10,1:10) %>%
+#'        axis(side=1, at=seq(1,10,length.out=18),las=3) %>%
+#'        axis(side=3, labels=FALSE) %>%
+#'        grid(side=c(1,2),col="green") %>%
+#'        grid(side=c(3,4))
+#' summary(gs)
+summary.gsplot <- function(object,...){
+  
+  view.info <- view_info(object)
+  cat("Summary information of plotting object:\n")
+  cat(nrow(view.info),"views:\n")
+  for(i in seq_len(nrow(view.info))){
+    cat("View:",i,"\nx side:", view.info$x[i], ",y side:", view.info$y[i], "\n")
+    cat("xlim:",as.numeric(xlim(object, side=view.info$x[i])[[1]]),",")
+    cat("ylim:",as.numeric(ylim(object, side=view.info$y[i])[[1]]))
+    if(view.info$log[i] != ""){
+      cat(",log:",view.info$log[i])
+    }
+    cat("\n")
+  }
+}
+

man/summary.gsplot.Rd

@@ -0,0 +1,26 @@
+% Generated by roxygen2 (4.1.1): do not edit by hand
+% Please edit documentation in R/gsplot-class.R
+\name{summary.gsplot}
+\alias{summary.gsplot}
+\title{Summary of gsplot object}
+\usage{
+\method{summary}{gsplot}(object, ...)
+}
+\arguments{
+\item{object}{list}
+
+\item{\dots}{additional parameters}
+}
+\description{
+Summary information
+}
+\examples{
+gs <- gsplot() \%>\%
+       points(1:10,1:10) \%>\%
+       axis(side=1, at=seq(1,10,length.out=18),las=3) \%>\%
+       axis(side=3, labels=FALSE) \%>\%
+       grid(side=c(1,2),col="green") \%>\%
+       grid(side=c(3,4))
+summary(gs)
+}
+

tests/testthat/test-access_gsplot.R

@@ -68,3 +68,10 @@ test_that("logged side extractor ",{
   expect_equal(length(dual), 2)
   expect_true(all(dual))
 })
+
+test_that("summary ",{
+  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_output(summary(usrDef),regexp = "2 views:")
+})