Commit d9e5a2c6 authored by Laura A DeCicco's avatar Laura A DeCicco
Browse files

Merge pull request #61 from ldecicco-USGS/master

Debugging latex error.
parents 607b849c 983cc12e
......@@ -7,8 +7,7 @@
#' that can be found here: \url{http://help.waterdata.usgs.gov/codes-and-parameters/parameters}. To get a
#' complete list of all current parameter codes in the USGS, use "all" as the input.
#' @keywords data import USGS web service
#' @return parameterData data frame with all information from the USGS about the particular parameter.
#'
#' @return parameterData data frame with the following information:
#' \tabular{lll}{
#' Name \tab Type \tab Description\cr
#' parameter_cd \tab character \tab 5-digit USGS parameter code \cr
......@@ -20,6 +19,7 @@
#' }
#'
#' @export
#' @seealso \code{\link{importRDB1}}
#' @examples
#' paramINFO <- readNWISpCode(c('01075','00060','00931'))
readNWISpCode <- function(parameterCd){
......
......@@ -55,6 +55,7 @@
#' timeZoneChange <- readNWISuv(c('04024430','04024000'),parameterCd,
#' "2013-11-03","2013-11-03")
#' }
#'
readNWISuv <- function (siteNumbers,parameterCd,startDate="",endDate="", tz=""){
url <- constructNWISURL(siteNumbers,parameterCd,startDate,endDate,"uv",format="xml")
......@@ -66,8 +67,7 @@ readNWISuv <- function (siteNumbers,parameterCd,startDate="",endDate="", tz=""){
#' Reads peak flow data from NWISweb.
#'
#' Reads peak flow from NWISweb.
#' Data is retrieved from \url{http://waterdata.usgs.gov/nwis}.
#' Reads peak flow from NWISweb. Data is retrieved from \url{http://waterdata.usgs.gov/nwis}.
#'
#' @param siteNumbers character USGS site number(or multiple sites). This is usually an 8 digit number.
#' @param startDate character starting date for data retrieval in the form YYYY-MM-DD. Default is "" which indicates
......@@ -100,6 +100,7 @@ readNWISuv <- function (siteNumbers,parameterCd,startDate="",endDate="", tz=""){
#' comment \tab character \tab Header comments from the RDB file \cr
#' siteInfo \tab data.frame \tab A data frame containing information on the requested sites \cr
#' }
#' @seealso \code{\link{constructNWISURL}}, \code{\link{importRDB1}}
#' @export
#' @examples
#' siteNumbers <- c('01594440','040851325')
......@@ -153,6 +154,7 @@ readNWISpeak <- function (siteNumbers,startDate="",endDate=""){
#'
#' @note Not all active USGS streamgages have traditional rating curves that
#'relate flow to stage.
#' @seealso \code{\link{constructNWISURL}}, \code{\link{importRDB1}}
#' @export
#' @examples
#' siteNumber <- '01594440'
......@@ -215,6 +217,7 @@ readNWISrating <- function (siteNumber,type="base"){
#' comment \tab character \tab Header comments from the RDB file \cr
#' siteInfo \tab data.frame \tab A data frame containing information on the requested sites \cr
#' }
#' @seealso \code{\link{constructNWISURL}}, \code{\link{importRDB1}}
#' @export
#' @examples
#' siteNumbers <- c('01594440','040851325')
......@@ -271,11 +274,12 @@ readNWISmeas <- function (siteNumbers,startDate="",endDate="", tz=""){
#' \tabular{lll}{
#' Name \tab Type \tab Description \cr
#' url \tab character \tab The url used to generate the data \cr
#' siteInfo \tab data.frame \tab A data frame containing information on the requested sites \cr
#' queryTime \tab POSIXct \tab The time the data was returned \cr
#' comment \tab character \tab Header comments from the RDB file \cr
#' siteInfo \tab data.frame \tab A data frame containing information on the requested sites \cr
#' }
#'
#' @seealso \code{\link{importRDB1}}
#' @seealso \code{\link{constructNWISURL}}, \code{\link{importRDB1}}
#' @export
#' @examples
#' siteNumber <- "434400121275801"
......
......@@ -8,7 +8,6 @@ install:
ps: Bootstrap
build_script:
- travis-tool.sh install_github USGS-R/EGRET
- travis-tool.sh install_deps
test_script:
......
......@@ -34,8 +34,9 @@ There are also several useful attributes attached to the data frame:
\tabular{lll}{
Name \tab Type \tab Description \cr
url \tab character \tab The url used to generate the data \cr
siteInfo \tab data.frame \tab A data frame containing information on the requested sites \cr
queryTime \tab POSIXct \tab The time the data was returned \cr
comment \tab character \tab Header comments from the RDB file \cr
siteInfo \tab data.frame \tab A data frame containing information on the requested sites \cr
}
}
\description{
......@@ -53,6 +54,6 @@ data2 <- readNWISgwl(sites, '','')
data3 <- readNWISgwl("420125073193001", '','')
}
\seealso{
\code{\link{importRDB1}}
\code{\link{constructNWISURL}}, \code{\link{importRDB1}}
}
......@@ -49,4 +49,7 @@ See \url{http://waterdata.usgs.gov/usa/nwis/sw} for details about surface water.
siteNumbers <- c('01594440','040851325')
data <- readNWISmeas(siteNumbers)
}
\seealso{
\code{\link{constructNWISURL}}, \code{\link{importRDB1}}
}
......@@ -11,8 +11,7 @@ that can be found here: \url{http://help.waterdata.usgs.gov/codes-and-parameters
complete list of all current parameter codes in the USGS, use "all" as the input.}
}
\value{
parameterData data frame with all information from the USGS about the particular parameter.
parameterData data frame with the following information:
\tabular{lll}{
Name \tab Type \tab Description\cr
parameter_cd \tab character \tab 5-digit USGS parameter code \cr
......@@ -30,6 +29,9 @@ This function gets the data from here: \url{http://nwis.waterdata.usgs.gov/nwis/
\examples{
paramINFO <- readNWISpCode(c('01075','00060','00931'))
}
\seealso{
\code{\link{importRDB1}}
}
\keyword{USGS}
\keyword{data}
\keyword{import}
......
......@@ -43,11 +43,13 @@ siteInfo \tab data.frame \tab A data frame containing information on the request
}
}
\description{
Reads peak flow from NWISweb.
Data is retrieved from \url{http://waterdata.usgs.gov/nwis}.
Reads peak flow from NWISweb. Data is retrieved from \url{http://waterdata.usgs.gov/nwis}.
}
\examples{
siteNumbers <- c('01594440','040851325')
data <- readNWISpeak(siteNumbers)
}
\seealso{
\code{\link{constructNWISURL}}, \code{\link{importRDB1}}
}
......@@ -45,4 +45,7 @@ siteNumber <- '01594440'
data <- readNWISrating(siteNumber, "base")
attr(data, "RATING")
}
\seealso{
\code{\link{constructNWISURL}}, \code{\link{importRDB1}}
}
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment