R/segments.R

In USGS-R/gsplot: Geological Survey Plotting

#' gsplot segments
#'
#' Creates line segments in the plot.  See \code{\link[graphics]{segments}} for more details.
#' 
#' @details Additional graphical parameter inputs:
#' \itemize{
#'  \item{\code{x0, y0}} {coordinates for the start of the segment}
#'  \item{\code{x, y}} {coordinates for the end of the segment}
#'  \item{\code{col, lty, lwd}} {parameters describing the color, type, and width of the segment, respectively}
#'  \item{\code{legend.name}} {name that appears in the legend, see \code{\link{legend}} for more legend parameters}
#' }
#' @seealso \code{\link[graphics]{segments}}
#' 
#' @param object gsplot object
#' @param \dots Further graphical parameters may also be supplied as arguments. See 'Details'.
#' 
#' @export
#' @examples
#' gs <- gsplot()
#' gsNew <- points(gs, y=1, x=2, xlim=c(0,NA),ylim=c(0,NA),
#'             col="blue", pch=18, legend.name="Points")
#' gsNew <- lines(gsNew, c(3,4,3), c(2,4,6), legend.name="Lines")
#' gsNew <- abline(gsNew, b=1, a=0, legend.name="1:1")
#' gsNew <- legend(gsNew, location="topleft",title="Awesome!")
#' gsNew <- grid(gsNew)
#' gsNew <- segments(gsNew, x0=2, y0=0.75, y1=1.25)
#' gsNew
segments <- function(object, ...) {
  override("graphics", "segments", object, ...)
}


segments.gsplot <- function(object, ..., legend.name=NULL, side=c(1,2)){
  fun.name <- 'segments'
  object <- gather_function_info(object, fun.name, ..., legend.name=legend.name, side=side)
  return(object)
}