OCD seealso

Author: ldecicco-USGS

R/abline.R

@@ -16,6 +16,7 @@
 #'  
 #'
 #' @export
+#' @seealso \code{\link[graphics]{abline}}
 #' @examples
 #' gs <- gsplot()
 #' gsNew <- points(gs, y=1, x=2, col="blue", pch=18, legend.name="Points")

R/arrows.R

@@ -1,6 +1,6 @@
 #' gsplot arrows
 #'
-#' Creates an arrow pointing at a specified plot location.   See \code{\link[graphics]{arrows}} for more details.
+#' Creates an arrow pointing at a specified plot location. See \code{\link[graphics]{arrows}} for more details.
 #' 
 #' @param object gsplot object
 #' @param \dots Further graphical parameters may also be supplied as arguments. See 'Details'.
@@ -14,6 +14,7 @@
 #' }
 #' 
 #' @export
+#' @seealso \code{\link[graphics]{arrows}}
 #' @examples
 #' gs <- gsplot() %>%
 #'    points( y=c(3,1,2), x=1:3, xlim=c(0,NA),ylim=c(0,NA),

R/axis.R

@@ -12,6 +12,7 @@
 #'  }
 #'    
 #' @rdname axis
+#' @seealso \code{\link[graphics]{axis}}
 #' @export
 #' @examples
 #' gs <- gsplot() %>%

R/curve.R

@@ -23,6 +23,7 @@
 #'  }
 #'    
 #' @rdname curve
+#' @seealso \code{\link[graphics]{curve}}
 #' @export
 #' @importFrom lazyeval lazy lazy_eval
 #' @examples

R/grid.R

@@ -6,6 +6,7 @@
 #' @param \dots Further graphical parameters may also be supplied as arguments
 #' 
 #' @export
+#' @seealso \code{\link[graphics]{grid}}
 #' @examples
 #' gs <- gsplot()
 #' gsNew <- points(gs, y=1, x=2, xlim=c(0,NA),ylim=c(0,NA),

R/gsplot-class.R

@@ -4,8 +4,9 @@
 #'
 #' @param x list
 #' @param \dots Further graphical parameters may also be supplied as arguments. See 'Details'.
-#' @param config.file path to config yaml for individual gsplot object
-#' @param theme path to theme
+#' @param config.file path to config yaml for individual gsplot object. Default is \code{NA} and means config options are taken from options.
+#' @param theme path to theme for individual gsplot object. Default is \code{NA} and means no theme.
+#' @param frame.plot logical. Defaults to \code{TRUE}
 #' @return gsplot 
 #' @export
 #' @rdname gsplot
@@ -15,9 +16,10 @@ gsplot <- function(x = NULL, ...) UseMethod("gsplot")
 
 #' @rdname gsplot
 #' @export
-gsplot.default <- function(...,config.file=NA, theme=NA) {
-  object <- gsplot(list(global=list('config'=list(frame.plot=TRUE, 
-                                                  config.file=!is.na(config.file)))))
+gsplot.default <- function(...,config.file=NA, theme=NA, frame.plot=TRUE) {
+  object <- gsplot(list(global=list('config'=list(frame.plot=frame.plot, 
+                                                  config.file=!is.na(config.file),
+                                                  theme=!is.na(theme)))))
 
   if (!is.na(config.file)){
     load_temp_config(config.file)

R/legend.R

@@ -22,6 +22,7 @@
 #' density, pt.bg, pt.cex, pt.lwd, text.col, text.font}
 #'  
 #' @export
+#' @seealso \code{\link[graphics]{legend}}
 #' @importFrom graphics par
 #' @examples
 #' 

R/lines.R

@@ -16,6 +16,7 @@
 #'  \item{\code{callouts}} {add callouts and text to the defined line, see \code{\link{callouts}} 
 #'  for arguments, must add arguments as a list}
 #' }  
+#' @seealso \code{\link[graphics]{lines}}
 #'    
 #' @examples
 #' gsNew <- gsplot()

R/mtext.R

@@ -13,6 +13,7 @@
 #' }
 #'    
 #' @export
+#' @seealso \code{\link[graphics]{mtext}}
 #' @examples
 #' gs <- gsplot()
 #' gsNew <- points(gs, y=1, x=2, col="blue", pch=18, legend.name="Points")

R/par.R

@@ -8,7 +8,7 @@
 #' @param object gsplot object
 #' @param \dots Further graphical parameters may also be supplied as arguments. See \code{\link[graphics]{par}}
 #' 
-#' 
+#' @seealso \code{\link[graphics]{par}}
 #' @export
 #' @examples
 #' gs2 <- gsplot(new=TRUE,mar=c(5,4,1,2)) %>%