Package: dataRetrieval 2.7.25

dataRetrieval: Retrieval Functions for USGS and EPA Hydrology and Water Quality Data

Collection of functions to help retrieve U.S. Geological Survey and U.S. Environmental Protection Agency water quality and hydrology data from web services.

Authors:Laura DeCicco [aut, cre], Robert Hirsch [aut], David Lorenz [aut], Jordan Read [ctb], Jordan Walker [ctb], Lindsay Platt [ctb], David Watkins [aut], David Blodgett [aut], Mike Johnson [aut], Aliesha Krall [ctb], Lee Stanish [ctb], Joseph Zemmels [aut], Elise Hinman [aut], Michael Mahoney [ctb]

dataRetrieval_2.7.25.tar.gz
dataRetrieval_2.7.25.zip(r-4.7)dataRetrieval_2.7.25.zip(r-4.6)dataRetrieval_2.7.25.zip(r-4.5)
dataRetrieval_2.7.25.tgz(r-4.6-any)dataRetrieval_2.7.25.tgz(r-4.5-any)
dataRetrieval_2.7.25.tar.gz(r-4.7-any)dataRetrieval_2.7.25.tar.gz(r-4.6-any)
dataRetrieval_2.7.25.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
card.svg |card.png
dataRetrieval/json (API)
NEWS

# Install 'dataRetrieval' in R:
install.packages('dataRetrieval', repos = c('https://ldecicco-usgs.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/doi-usgs/dataretrieval/issues

On CRAN:

Conda:

usgs

14.04 score 324 stars 16 packages 1.8k scripts 7.1k downloads 3 mentions 75 exports 49 dependencies

Last updated from:652f165aad. Checks:9 OK. Indexed: no.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK165
source / vignettesOK230
linux-release-x86_64OK164
macos-release-arm64OK110
macos-oldrel-arm64OK115
windows-develOK108
windows-releaseOK99
windows-oldrelOK103
wasm-releaseOK129

Exports:addWaterYearcalcWaterYearcheck_OGC_requestscheck_waterdata_sample_paramscheckWQPdatesconstruct_api_requestsconstruct_waterdata_sample_requestconstructNWISURLconstructWQPURLcountyCdcountyCdLookupcreate_NWIS_bibcreate_WQP_bibfindNLDIget_nldi_sourcesget_ogc_paramsgetWebServiceDataimportNGWMNimportRDB1importWaterML1importWaterML2importWQPis_dataRetrieval_userparameterCdFileparse_WQPpcode_to_namepCodeToNameread_USGS_samplesread_waterdataread_waterdata_channelread_waterdata_combined_metaread_waterdata_continuousread_waterdata_dailyread_waterdata_field_measurementsread_waterdata_field_metaread_waterdata_latest_continuousread_waterdata_latest_dailyread_waterdata_metadataread_waterdata_monitoring_locationread_waterdata_parameter_codesread_waterdata_peaksread_waterdata_ratingsread_waterdata_samplesread_waterdata_stats_daterangeread_waterdata_stats_porread_waterdata_ts_metareadNGWMNdatareadNGWMNlevelsreadNGWMNsitesreadNWISdatareadNWISdvreadNWISpCodereadNWISpeakreadNWISratingreadNWISsitereadNWISstatreadNWISusereadNWISuvreadWQPdatareadWQPqwreadWQPsummaryrenameNWISColumnssetAccessstateCdstateCdLookupsummarize_USGS_samplessummarize_waterdata_sampleswhatNWISdatawhatNWISsiteswhatWQPdatawhatWQPmetricswhatWQPsampleswhatWQPsiteswqp_check_statuszeroPad

Dependencies:askpassbitbit64classclassIntclicliprcpp11crayoncurldata.tableDBIe1071genericsgluehmshttr2jsonliteKernSmoothlifecyclelubridatemagrittrMASSopensslpillarpkgconfigprettyunitsprogressproxyR6rappdirsRcppreadrrlangs2sfsystibbletidyselecttimechangetzdbunitsutf8vctrsvroomwhiskerwithrwkxml2

Introduction to the dataRetrieval package

Laura A. DeCicco and Robert M. Hirsch

Rendered fromdataRetrieval.Rmdusingknitr::rmarkdownon Jun 02 2026.

Last update: 2026-05-26
Started: 2017-05-19

Readme and manuals

Help Manual

Help pageTopics
add a water year columnaddWaterYear
Extract WY from a datecalcWaterYear
Check values from codeservicecheck_waterdata_sample_params
Date Check for Water Quality PortalcheckWQPdates
Construct NWIS url for data retrievalconstructNWISURL
Construct WQP url for data retrievalconstructWQPURL
US County Code Lookup TablecountyCd
US county code look upcountyCdLookup
Create NWIS data citationcreate_NWIS_bib
Create WQP data citationcreate_WQP_bib
R Client for the Network Linked Data IndexfindNLDI
Get current NLDI offeringsget_nldi_sources
Get parameter descriptionsget_ogc_params
getting header information from a WQP querygetQuerySummary
Function to return data from web servicesgetWebServiceData
Function to return data from the National Ground Water Monitoring Network waterML2 formatimportNGWMN
Function to return data from the NWIS RDB 1.0 formatimportRDB1
Function to return data from the NWISWeb WaterML1.1 serviceimportWaterML1
Parse the WaterML2 timeseries portion of a waterML2 fileimportWaterML2
Basic Water Quality Portal Data parserimportWQP
Is this a dataRetrieval useris_dataRetrieval_user
List of USGS parameter codesparameterCdFile
Convert WQP columns to correct typesparse_WQP
Parameter code to characteristic namepcode_to_name
Generalized USGS Water Data API retrieval functionread_waterdata
Get USGS Channel Measurementsread_waterdata_channel
Get USGS Monitoring Location Metadataread_waterdata_combined_meta
Get Continuous USGS Water Dataread_waterdata_continuous
Get USGS Daily Dataread_waterdata_daily
Get USGS Field Measurement Water Dataread_waterdata_field_measurements
Get USGS Field Measurement Metadataread_waterdata_field_meta
Get Latest Continuous USGS Water Dataread_waterdata_latest_continuous
Get Latest USGS Daily Dataread_waterdata_latest_daily
Generalized USGS Water Meta Data API retrieval functionread_waterdata_metadata
Get USGS Monitoring Location Dataread_waterdata_monitoring_location
Get USGS Parameter Code Informationread_waterdata_parameter_codes
Get USGS Peak Dataread_waterdata_peaks
Get USGS Rating Curve Dataread_waterdata_ratings
USGS Samples Dataread_waterdata_samples
Get USGS daily data statisticsread_waterdata_stats_daterange read_waterdata_stats_por
Get USGS Time Series Metadataread_waterdata_ts_meta
Import data from the National Groundwater Monitoring Network.readNGWMNdata
Retrieve groundwater levels from the National Ground Water Monitoring Network.readNGWMNlevels
Retrieve site data from the National Ground Water Monitoring Network.readNGWMNsites
General Data Import from NWISreadNWISdata
Daily Value USGS NWIS Data RetrievalreadNWISdv
USGS Parameter Data RetrievalreadNWISpCode
Peak flow data from USGS (NWIS)readNWISpeak
Rating table for an active USGS streamgage retrievalreadNWISrating
USGS Site File Data RetrievalreadNWISsite
Site statistics retrieval from USGS (NWIS)readNWISstat
Water use data retrieval from USGS (NWIS)readNWISuse
Instantaneous value data retrieval from USGS (NWIS)readNWISuv
General Data Import from Water Quality PortalreadWQPdata
Raw Data Import for Water Quality PortalreadWQPqw
Summary of Data Available from Water Quality PortalreadWQPsummary
renameColumnsrenameNWISColumns
Set data endpointsetAccess
US State Code Lookup TablestateCd
State code look upstateCdLookup
USGS Samples Summary Datasummarize_USGS_samples summarize_waterdata_samples
USGS data availabilitywhatNWISdata
Site Data Import from NWISwhatNWISsites
Data Available from Water Quality PortalwhatWQPdata
Site Data Import from Water Quality PortalwhatWQPmetrics whatWQPsamples whatWQPsites
Get WQP service metadatawqp_check_status
Pad string with leading zeroszeroPad