Merge pull request #454 from ldecicco-USGS/errorArgs

Error args

Author: Lindsay Carr

R/add_to_view.R

@@ -64,7 +64,7 @@ add_to_view <- function(object, call.args, side, where){
 #' gs <- gsplot() %>% 
 #'          points(x=1:5, y=1:5, xlim=c(0,10), ylim=c(0,10), 
 #'                callouts(labels=c(rep(NA, 4), "oh")), 
-#'                error_bar(y.high=1))
+#'                error_bar(offset.up=1))
 #' gs
 #' 
 #' gsplot:::filter_arguments('points', x=2:6, y=2:6, ylim=c(-1, 11))$call.args

R/arrows.R

@@ -23,8 +23,8 @@
 #'    abline(b=1, a=0, legend.name="1:1") %>%
 #'    legend(location="topleft",title="Awesome!") %>%
 #'    grid() %>%
-#'    error_bar(x=1:3, y=c(3,1,2), y.high=c(0.5,0.25,1), y.low=0.1) %>%
-#'    error_bar(x=1:3, y=c(3,1,2), x.low=.2, x.high=.2, col="red",lwd=3) %>%
+#'    error_bar(x=1:3, y=c(3,1,2), offset.up=c(0.5,0.25,1), offset.down=0.1) %>%
+#'    error_bar(x=1:3, y=c(3,1,2), offset.left=.2, offset.right=.2, col="red",lwd=3) %>%
 #'    arrows(x0=0.75, y0=2, x1=1, y1=2.8, lwd=2) %>%
 #'    title("Graphing Fun") %>%
 #'    text(.75,1.75,labels="Weird data")

R/error_bars.R

@@ -8,8 +8,8 @@
 #' @details Additional graphical parameter inputs:
 #' \itemize{
 #'  \item{\code{x, y}} {location of error_bar origin}
-#'  \item{\code{y.high, y.low}} {the y-value specifying the error above the point (high) and below the point (low)}
-#'  \item{\code{x.high, x.low}} {the x-value specifying the error above the point (high) and below the point (low)}
+#'  \item{\code{offset.up, offset.down}} {the y-value specifying the error above the point (high) and below the point (low)}
+#'  \item{\code{offset.right, offset.left}} {the x-value specifying the error above the point (high) and below the point (low)}
 #'  \item{\code{epsilon}} {width of the end of the error bar (in inches)}
 #'  \item{\code{legend.name}} {name that appears in the legend, see \code{\link{legend}} for more legend parameters}
 #' } 
@@ -24,20 +24,23 @@
 #' gsNew <- abline(gsNew, b=1, a=0, legend.name="1:1")
 #' gsNew <- legend(gsNew, location = "topleft",title="Awesome!")
 #' gsNew <- grid(gsNew)
-#' gsNew <- error_bar(gsNew, 1:3, y=c(3,1,2), y.high=c(0.5,0.25,1), y.low=0.1)
-#' gsNew <- error_bar(gsNew, x=1:3, y=c(3,1,2), x.low=c(.2,NA,.2), x.high=.2, col="red",lwd=3)
+#' gsNew <- error_bar(gsNew, 1:3, y=c(3,1,2), 
+#'                    offset.up=c(0.5,0.25,1), offset.down=0.1)
+#' gsNew <- error_bar(gsNew, x=1:3, y=c(3,1,2), 
+#'                    offset.left=c(.2,NA,.2), 
+#'                    offset.right=.2, col="red",lwd=3)
 #' gsNew <- title(gsNew, "Graphing Fun")
 #' gsNew
 #' 
 #' yData <- rnorm(100,mean=10000, sd=1000) 
 #' gs <- gsplot() %>%
 #'    points(1:100, yData, log="y") %>%
-#'    error_bar(50:60, yData[50:60], y.high=250) 
+#'    error_bar(50:60, yData[50:60], offset.up=250) 
 #' gs
 #' 
 #' gs <- gsplot() %>%
 #'    points(1:10, 1:10) %>%
-#'    error_bar(5, 5, y.high=1, col="green") 
+#'    error_bar(5, 5, offset.up=1, col="green") 
 #' gs 
 error_bar <- function(object, ...) {
   override("gsplot", "error_bar", object, ...)
@@ -67,101 +70,101 @@ error_bar.gsplot <- function(object, ..., legend.name=NULL, side=c(1,2)){
 #' 
 #' @param x location in x
 #' @param y location in y
-#' @param y.high offset up
-#' @param y.low offset down
-#' @param x.high offset right
-#' @param x.low offset left
+#' @param offset.up offset up
+#' @param offset.down offset down
+#' @param offset.right offset right
+#' @param offset.left offset left
 #' @param epsilon width of bar in relative units
 #' @param \dots additional arguments passed to \code{\link[graphics]{arrows}}
 #' @export
 #' @examples 
 #' plot(1:10, 1:10)
-#' error_bar(5, 5, y.high=1, col="green")
-error_bar.default <- function(x, y, y.high=0, y.low=0, x.high=0, x.low=0, epsilon=0.1, ...){
+#' error_bar(5, 5, offset.up=1, col="green")
+error_bar.default <- function(x, y, offset.up=0, offset.down=0, offset.right=0, offset.left=0, epsilon=0.1, ...){
 
-  data.list <- calculate_error_bars(x=x,y=y,y.high=y.high,y.low=y.low,x.high=x.high, x.low=x.low, epsilon=epsilon)
+  data.list <- calculate_error_bars(x=x,y=y,offset.up=offset.up,offset.down=offset.down,offset.right=offset.right, offset.left=offset.left, epsilon=epsilon)
 
-  if(length(data.list[["y.low"]]) > 1){
-    graphics::arrows(x0=data.list[["y.low"]]$x0, 
-           y0=data.list[["y.low"]]$y0,
-           x1=data.list[["y.low"]]$x1,
-           y1=data.list[["y.low"]]$y1, 
-           length=data.list[["y.low"]]$length, angle=90, ...)
+  if(length(data.list[["offset.down"]]) > 1){
+    graphics::arrows(x0=data.list[["offset.down"]]$x0, 
+           y0=data.list[["offset.down"]]$y0,
+           x1=data.list[["offset.down"]]$x1,
+           y1=data.list[["offset.down"]]$y1, 
+           length=data.list[["offset.down"]]$length, angle=90, ...)
   }
 
-  if(length(data.list[["y.high"]]) > 1){
-    graphics::arrows(x0=data.list[["y.high"]]$x0, 
-           y0=data.list[["y.high"]]$y0,
-           x1=data.list[["y.high"]]$x1,
-           y1=data.list[["y.high"]]$y1, 
-           length=data.list[["y.high"]]$length, angle=90, ...)
+  if(length(data.list[["offset.up"]]) > 1){
+    graphics::arrows(x0=data.list[["offset.up"]]$x0, 
+           y0=data.list[["offset.up"]]$y0,
+           x1=data.list[["offset.up"]]$x1,
+           y1=data.list[["offset.up"]]$y1, 
+           length=data.list[["offset.up"]]$length, angle=90, ...)
   }
 
-  if(length(data.list[["x.low"]]) > 1){
-    graphics::arrows(x0=data.list[["x.low"]]$x0, 
-           y0=data.list[["x.low"]]$y0,
-           x1=data.list[["x.low"]]$x1,
-           y1=data.list[["x.low"]]$y1, 
-           length=data.list[["x.low"]]$length, angle=90, ...)
+  if(length(data.list[["offset.left"]]) > 1){
+    graphics::arrows(x0=data.list[["offset.left"]]$x0, 
+           y0=data.list[["offset.left"]]$y0,
+           x1=data.list[["offset.left"]]$x1,
+           y1=data.list[["offset.left"]]$y1, 
+           length=data.list[["offset.left"]]$length, angle=90, ...)
   }
 
-  if(length(data.list[["x.high"]]) > 1){
-    graphics::arrows(x0=data.list[["x.high"]]$x0, 
-           y0=data.list[["x.high"]]$y0,
-           x1=data.list[["x.high"]]$x1,
-           y1=data.list[["x.high"]]$y1, 
-           length=data.list[["x.high"]]$length, angle=90, ...)
+  if(length(data.list[["offset.right"]]) > 1){
+    graphics::arrows(x0=data.list[["offset.right"]]$x0, 
+           y0=data.list[["offset.right"]]$y0,
+           x1=data.list[["offset.right"]]$x1,
+           y1=data.list[["offset.right"]]$y1, 
+           length=data.list[["offset.right"]]$length, angle=90, ...)
   }
 
   return()
 }
 
-calculate_error_bars <- function(x, y, y.high=0, y.low=0, x.high=0, x.low=0, epsilon=0.1, ...){
-  y.high[is.na(y.high)] <- 0
-  y.low[is.na(y.low)] <- 0
-  x.high[is.na(x.high)] <- 0
-  x.low[is.na(x.low)] <- 0
+calculate_error_bars <- function(x, y, offset.up=0, offset.down=0, offset.right=0, offset.left=0, epsilon=0.1, ...){
+  offset.up[is.na(offset.up)] <- 0
+  offset.down[is.na(offset.down)] <- 0
+  offset.right[is.na(offset.right)] <- 0
+  offset.left[is.na(offset.left)] <- 0
 
   data.list <- rep(list(list()), 4) 
-  names(data.list) <- c("y.low","y.high","x.low","x.high")
+  names(data.list) <- c("offset.down","offset.up","offset.left","offset.right")
 
-  if(!all(y.low == 0)){
-    y.low.coord <- y-y.low
-    errorIndex <- (y-y.low.coord) != 0
-    y.low.coord <- y.low.coord[errorIndex]
+  if(!all(offset.down == 0)){
+    offset.down.coord <- y-offset.down
+    errorIndex <- (y-offset.down.coord) != 0
+    offset.down.coord <- offset.down.coord[errorIndex]
     y.error <- y[errorIndex]
     x.error <- x[errorIndex]
-    data.list[["y.low"]] <- list(x0=x.error, y0=y.error, x1=x.error, y1=y.low.coord, 
+    data.list[["offset.down"]] <- list(x0=x.error, y0=y.error, x1=x.error, y1=offset.down.coord, 
            length=epsilon, angle=90)
   }
 
-  if(!all(y.high == 0)){
-    y.high.coord <- y+y.high
-    errorIndex <- (y-y.high.coord) != 0
-    y.high.coord <- y.high.coord[errorIndex]
+  if(!all(offset.up == 0)){
+    offset.up.coord <- y+offset.up
+    errorIndex <- (y-offset.up.coord) != 0
+    offset.up.coord <- offset.up.coord[errorIndex]
     y.error <- y[errorIndex]
     x.error <- x[errorIndex]
-    data.list[["y.high"]] <- list(x0=x.error, y0=y.error, x1=x.error, y1=y.high.coord, length=epsilon, 
+    data.list[["offset.up"]] <- list(x0=x.error, y0=y.error, x1=x.error, y1=offset.up.coord, length=epsilon, 
            angle=90)
   }
 
-  if(!all(x.low == 0)){
-    x.low.coord <- x-x.low
-    errorIndex <- (x-x.low.coord) != 0
-    x.low.coord <- x.low.coord[errorIndex]
+  if(!all(offset.left == 0)){
+    offset.left.coord <- x-offset.left
+    errorIndex <- (x-offset.left.coord) != 0
+    offset.left.coord <- offset.left.coord[errorIndex]
     x.error <- x[errorIndex]
     y.error <- y[errorIndex]
-    data.list[["x.low"]] <- list(x0=x.error, y0=y.error, x1=x.low.coord, y1=y.error, length=epsilon, 
+    data.list[["offset.left"]] <- list(x0=x.error, y0=y.error, x1=offset.left.coord, y1=y.error, length=epsilon, 
            angle=90)
   }
 
-  if(!all(x.high == 0)){
-    x.high.coord <- x+x.high
-    errorIndex <- (x-x.high.coord) != 0
-    x.high.coord <- x.high.coord[errorIndex]
+  if(!all(offset.right == 0)){
+    offset.right.coord <- x+offset.right
+    errorIndex <- (x-offset.right.coord) != 0
+    offset.right.coord <- offset.right.coord[errorIndex]
     x.error <- x[errorIndex]
     y.error <- y[errorIndex]
-    data.list[["x.high"]] <- list(x0=x.error, y0=y.error, x1=x.high.coord, y1=y.error, length=epsilon, 
+    data.list[["offset.right"]] <- list(x0=x.error, y0=y.error, x1=offset.right.coord, y1=y.error, length=epsilon, 
            angle=90)
   }
 

R/points.R

@@ -28,7 +28,7 @@
 #' gs <- gsplot() %>% 
 #'          points(x=1:5, y=1:5, xlim=c(0,10), ylim=c(0,10), 
 #'                callouts(labels=c(rep(NA, 4), "oh")), 
-#'                error_bar(y.high=1))
+#'                error_bar(offset.up=1))
 #' gs
 #' 
 #' gs2 <- gsplot() %>%

R/text.R

@@ -31,8 +31,8 @@
 #'   abline(b=1, a=0, legend.name="1:1") %>%
 #'   legend(location="topleft",title="Awesome!") %>%
 #'   grid() %>%
-#'   error_bar(x=1:3, y=c(3,1,2), y.high=c(0.5,0.25,1), y.low=0.1) %>%
-#'   error_bar(x=1:3, y=c(3,1,2), x.low=.2, x.high=.2, col="red",lwd=3) %>%
+#'   error_bar(x=1:3, y=c(3,1,2), offset.up=c(0.5,0.25,1), offset.down=0.1) %>%
+#'   error_bar(x=1:3, y=c(3,1,2), offset.left=.2, x.high=.2, col="red",lwd=3) %>%
 #'   arrows(x0=c(0.75, 1.75), y0=c(2,2.5), x1=c(1,2), y1=c(2.8,1.4), lwd=2) %>%
 #'   text(x=c(0.75, 1.75), y=c(1.75, 2.8),labels=c("Weird data", "Other Data")) %>%
 #'   title("Graphing Fun")

README.Rmd

@@ -150,7 +150,7 @@ arrows(x0 = 1:7, x1 = 1:7,
 ```{r message=FALSE, warning=FALSE}
 errorbarplot <- gsplot() %>% 
   points(1:7, 1:7) %>% 
-  error_bar(x = 1:7, y = 1:7, y.high = 1, y.low = 1)
+  error_bar(x = 1:7, y = 1:7, offset.up = 1, offset.down = 1)
 errorbarplot
 ```
 
@@ -220,7 +220,7 @@ text(x = 1.25:5.25, y = 1.25:5.25,
 ```{r }
 embedplot <- gsplot() %>% 
   points(1:5, 1:5, 
-         error_bar(y.high = 1, y.low = 0.5),
+         error_bar(offset.up = 1, offset.down = 0.5),
          callouts(labels = paste("pt", 1:5))) 
 embedplot
 ```
@@ -278,8 +278,8 @@ points(as.Date("2011-01-15"),2.5, col="blue", pch=20)
 demoPlot <- gsplot() %>%
   points(y=c(3,1,2), x=1:3, xlim=c(0,NA),ylim=c(0,NA),
          col="blue", pch=18, legend.name="Points", xlab="Index", 
-         error_bar(y.high = c(0.5,0.25,1), y.low = 0.1,
-                   x.low=0.2, x.high=0.2, col="red", lwd=2)) %>%
+         error_bar(offset.up = c(0.5,0.25,1), offset.down = 0.1,
+                   offset.left=0.2, offset.right=0.2, col="red", lwd=2)) %>%
   lines(c(3,4,3), c(2,4,6), legend.name="Lines", ylab=expression(paste("Data [ft"^"3","/s]"))) %>%
   abline(b=1, a=0, legend.name="1:1") %>%
   axis(side=c(3,4), labels=FALSE) %>%

README.md

@@ -179,7 +179,7 @@ arrows(x0 = 1:7, x1 = 1:7,
 ``` r
 errorbarplot <- gsplot() %>% 
   points(1:7, 1:7) %>% 
-  error_bar(x = 1:7, y = 1:7, y.high = 1, y.low = 1)
+  error_bar(x = 1:7, y = 1:7, offset.up = 1, offset.down = 1)
 errorbarplot
 ```
 
@@ -255,7 +255,7 @@ text(x = 1.25:5.25, y = 1.25:5.25,
 ``` r
 embedplot <- gsplot() %>% 
   points(1:5, 1:5, 
-         error_bar(y.high = 1, y.low = 0.5),
+         error_bar(offset.up = 1, offset.down = 0.5),
          callouts(labels = paste("pt", 1:5))) 
 embedplot
 ```
@@ -322,8 +322,8 @@ Improved workflow examples
 demoPlot <- gsplot() %>%
   points(y=c(3,1,2), x=1:3, xlim=c(0,NA),ylim=c(0,NA),
          col="blue", pch=18, legend.name="Points", xlab="Index", 
-         error_bar(y.high = c(0.5,0.25,1), y.low = 0.1,
-                   x.low=0.2, x.high=0.2, col="red", lwd=2)) %>%
+         error_bar(offset.up = c(0.5,0.25,1), offset.down = 0.1,
+                   offset.left=0.2, offset.right=0.2, col="red", lwd=2)) %>%
   lines(c(3,4,3), c(2,4,6), legend.name="Lines", ylab=expression(paste("Data [ft"^"3","/s]"))) %>%
   abline(b=1, a=0, legend.name="1:1") %>%
   axis(side=c(3,4), labels=FALSE) %>%

inst/doc/gsplotIntro.R

@@ -10,8 +10,8 @@ demoPlot <- gsplot() %>%
   abline(b=1, a=0, legend.name="1:1") %>%
   legend(location="topleft",title="Awesome!") %>%
   grid() %>%
-  error_bar(x=1:3, y=c(3,1,2), y.high=c(0.5,0.25,1), y.low=0.1) %>%
-  error_bar(x=1:3, y=c(3,1,2), x.low=.2, x.high=.2, col="red",lwd=3) %>%
+  error_bar(x=1:3, y=c(3,1,2), offset.up=c(0.5,0.25,1), offset.down=0.1) %>%
+  error_bar(x=1:3, y=c(3,1,2), offset.left=.2, offset.right=.2, col="red",lwd=3) %>%
   callouts(x=1, y=2.8, lwd=2, angle=250, labels="Weird data") %>%
   title("Graphing Fun")
 demoPlot

inst/doc/gsplotIntro.Rmd

@@ -25,8 +25,8 @@ demoPlot <- gsplot() %>%
   abline(b=1, a=0, legend.name="1:1") %>%
   legend(location="topleft",title="Awesome!") %>%
   grid() %>%
-  error_bar(x=1:3, y=c(3,1,2), y.high=c(0.5,0.25,1), y.low=0.1) %>%
-  error_bar(x=1:3, y=c(3,1,2), x.low=.2, x.high=.2, col="red",lwd=3) %>%
+  error_bar(x=1:3, y=c(3,1,2), offset.up=c(0.5,0.25,1), offset.down=0.1) %>%
+  error_bar(x=1:3, y=c(3,1,2), offset.left=.2, offset.right=.2, col="red",lwd=3) %>%
   callouts(x=1, y=2.8, lwd=2, angle=250, labels="Weird data") %>%
   title("Graphing Fun")
 demoPlot
@@ -35,7 +35,7 @@ demoPlot
 
 ## Overview
 
-`gsplot` uses similar plotting graphics to R base graphics, but allows users to execute them in a more intuitive manner. Additionally, as the complexity of the plot features increase, `gpslot` code is simplistic compared to that of base graphics. `gsplot` also includes features not present in base graphics that are useful when working with USGS data, such as `callouts` (combines `segments` and `text` into a single call), `error_bar` (allows an error to be given as `y.high`, `y.low`, `x.high`, and `x.low` and automatically builds an error bar), and the argument `legend.name` (an argument within `points`, `lines`, etc. which does not require colors, linetypes, and other par information to be redefined within the `legend` call).
+`gsplot` uses similar plotting graphics to R base graphics, but allows users to execute them in a more intuitive manner. Additionally, as the complexity of the plot features increase, `gpslot` code is simplistic compared to that of base graphics. `gsplot` also includes features not present in base graphics that are useful when working with USGS data, such as `callouts` (combines `segments` and `text` into a single call), `error_bar` (allows an error to be given as `offset.up`, `offset.down`, `offset.right`, and `offset.left` and automatically builds an error bar), and the argument `legend.name` (an argument within `points`, `lines`, etc. which does not require colors, linetypes, and other par information to be redefined within the `legend` call).
 
 ## Data manipulation