R/packageInfo.R

In USGS-R/USGSHydroTools: Collection of functions for hydrological analysis

.onAttach <- function(libname, pkgname) {
  packageStartupMessage(paste(strwrap(
    'USGS Research Package: 
    https://owi.usgs.gov/R/packages.html#research
    Report issues and ask questions:
    https://github.com/USGS-R/USGSHydroTools/issues'),
    collapse='\n'))
}

#' Example sample data.
#'
#' Example sample data. Needs more info.
#'
#' @name sampleData
#' @docType data
#' @author Steve Corsi \email{srcorsi@@usgs.gov}
#' @keywords discrete
NULL

#' Example flow data.
#'
#' Example instantaneous (unit value) flow data from Menomonee River at Wauwatosa, WI.
#'
#' @name flowData
#' @docType data
#' @author Steve Corsi \email{srcorsi@@usgs.gov}
#' @keywords instantaneous
NULL

#' Example water quality data included in GSHydroTools
#'
#' Example data representing composite fecal indicator bacteria from the Menomonee River at Wauwatosa, Wisconsin
#'
#' @name FIBdata
#' @docType data
#' @author Steve Corsi \email{srcorsi@@usgs.gov}
#' @keywords bacteria data
NULL

#' Example water quality data included in GSHydroTools
#'
#' Example data representing discrete total phosphorus concentrtions from the Menomonee River at Wauwatosa, Wisconsin
#'
#' @name WQdata
#' @docType data
#' @author Steve Corsi \email{srcorsi@@usgs.gov}
#' @keywords water quality data
#' 
NULL

#' Example USGS site information
#'
#' Raw data pulled from NWIS
#' @name stationINFO
#' @docType data
#' @keywords station data
NULL

#' Example USGS site information
#'
#' Station name, coordinates, label offsets, and line offsets for positioning
#' the labels on a map and lines from the data points to the labels
#' @name SI
#' @docType data
#' @keywords station data
NULL

#' Collection of functions for hydrological analysis.
#'
#' \tabular{ll}{
#' Package: \tab GSHydroTools\cr
#' Type: \tab Package\cr
#' Version: \tab 1.0.0\cr
#' Date: \tab 2014-01-10\cr
#' License: \tab Unlimited for this package, dependencies have more restrictive licensing.\cr
#' Copyright: \tab This software is in the public domain because it contains materials
#' that originally came from the United States Geological Survey, an agency of
#' the United States Department of Interior. For more information, see the
#' official USGS copyright policy at
#' http://www.usgs.gov/visual-id/credit_usgs.html#copyright\cr
#' LazyLoad: \tab yes\cr
#' }
#'
#' Collection of functions for hydrological analysis.
#'
#' @name GSHydroTools-package
#' @docType package
#' @author Steve Corsi \email{srcorsi@@usgs.gov}
NULL

#' Example sample dates.
#'
#' Example sample dates data. 
#'
#' @name sampleDates
#' @docType data
#' @author Steve Corsi \email{srcorsi@@usgs.gov}
#' @keywords instantaneous
NULL

#' Example event dates and times.
#'
#' Example event begin and end dates and times to define a sampled hydrograph
#'
#' @name events
#' @docType data
#' @author Steve Corsi \email{srcorsi@@usgs.gov}
#' @keywords hydrograph event dates
NULL

#' Example HYSEP output data.
#'
#' Example HYSEP output data. Needs more info.
#'
#' @name exampleHYSEP
#' @docType data
#' @author Steve Corsi \email{srcorsi@@usgs.gov}
#' @keywords instantaneous
NULL

#' Political boundaries.
#' 
#' Political boundary shapefiles from \url{http://dds.cr.usgs.gov/pub/data/nationalatlas/bound0m_shp_nt00298.tar.gz} 
#' @name shape_polibounds
#' @docType data
#' @keywords station data
NULL
#' Rivers in US.
#' 
#' River shapefiles from \url{http://dds.cr.usgs.gov/pub/data/nationalatlas/hydro0m_shp_nt00300.tar.gz} 
#' @name shape_hydroline
#' @docType data
#' @keywords station data
NULL
#' Lakes in US
#' 
#' Lake shapefiles from \url{http://dds.cr.usgs.gov/pub/data/nationalatlas/hydro0m_shp_nt00300.tar.gz} 
#' @name shape_hydropoly
#' @docType data
#' @keywords station data
NULL
#' Example data for correlations
#'
#' Example data with response and predictor variables
#'
#' @name dfOptical
#' @docType data
#' @author Steve Corsi \email{srcorsi@@usgs.gov}
#' @keywords correlation
NULL