EGRET: Exploration and Graphics for RivEr Trends (EGRET)
Version 2.6.0

Statistics and graphics for streamflow history, water quality trends, and the statistical modeling algorithm: Weighted Regressions on Time, Discharge, and Season (WRTDS).

AuthorRobert Hirsch [aut], Laura DeCicco [aut, cre]
Date of publication2016-07-27 02:53:18
MaintainerLaura DeCicco <ldecicco@usgs.gov>
LicenseCC0
Version2.6.0
URL http://pubs.usgs.gov/tm/04/a10/ https://github.com/USGS-R/EGRET/wiki
Package repositoryView on CRAN
InstallationInstall the latest version of this package by entering the following in R:
install.packages("EGRET")

Getting started

Package overview
README.md
Using Random Residuals for Censored Data in EGRET"

Popular man pages

boxResidMonth: A box plot of WRTDS residuals by month
EGRET-package: EGRET package includes WRTDS and flowHistory
fluxUnit-class: fluxUnit class
genericEGRETDotPlot: Generic EGRET plotting function
plotResidPred: Plot of the residuals from WRTDS versus the estimated values...
populateDaily: Populate Daily data frame
runSurvReg: Run the weighted survival regression for a set of estimation...
See all...

All man pages Function index File listing

Man pages

as.egret: Create named list for EGRET analysis
blankTime: Deletes the computed values during periods of time when there...
boxConcMonth: Box plot of the water quality data by month
boxConcThree: Three box plots side-by-side
boxQTwice: Two box plots side-by-side, discharge on sample days, and...
boxResidMonth: A box plot of WRTDS residuals by month
calculateMonthlyResults: Calculates monthly values of Q, Conc, Flux, FNConc, and...
censoredSegments: Generic plotting function to create censored line segments
checkStartEndDate: checkStartEndDate
compressData: Compress sample data frame
Constants: Constants included with EGRET
dataOverview: Data Overview for WRTDS
dateFormatCheck: Check date format
EGRET-package: EGRET package includes WRTDS and flowHistory
estCrossVal: Jack-Knife cross validation of the WRTDS (Weighted...
estDailyFromSurfaces: Estimates all daily values of Concentration, Flux,...
estSurfaces: Estimate the three surfaces (for yHat, SE and ConcHat) as a...
fixSampleFrame: Update Sample dataframe
flowDuration: Computes several values of the flow duration curve for...
fluxBiasMulti: Produces 8-panel plot that is useful for determining if there...
fluxBiasStat: Compute the flux bias statistic: (mean of estimated flux -...
fluxUnit-class: fluxUnit class
formatCheckDate: formatCheckDate
formatCheckParameterCd: formatCheckParameterCd
generalAxis: Axis generation for log discharge
genericEGRETDotPlot: Generic EGRET plotting function
getDaily: Get Daily dataframe from EGRET object
getInfo: Get INFO dataframe from EGRET object
getSample: Get Sample dataframe from EGRET object
getSurfaces: Get surfaces matrix from EGRET object
INFOdataframe: Import metadata to create INFO data frame
is.egret: Check for EGRET object
logPretty1: Sets up tick marks for an axis with a log scale, where the...
logPretty3: Sets up tick marks for an axis with a log scale
makeAnnualSeries: Produces annual series of 8 streamflow statistics (and a...
makeAugmentedSample: Create Randomized Residuals and Observations
mergeReport: Merge Sample and Daily Data into EGRET object
modelEstimation: Estimation process for the WRTDS (Weighted Regressions on...
monthLabel-class: monthLabel class
multiPlotDataOverview: Produces a 4 panel plot that gives an overview of the data...
plot15: Makes 15 graphs of streamflow statistics on a single page
plot1of15: plots 1 of the 15 graphs of streamflow statistics on a single...
plotConcHist: Graph of annual concentration and flow normalized...
plotConcPred: Plot of Observed Concentration versus Estimated Concentration
plotConcQ: Plot of Observed Concentration versus Discharge
plotConcQSmooth: Plot up to three curves representing the concentration versus...
plotConcTime: Plot of Observed Concentration versus Time
plotConcTimeDaily: Plot of the time series of daily concentration estimates and...
plotConcTimeSmooth: Plot up to three curves representing the concentration versus...
plotContours: Color contour plot of the estimated surfaces as a function of...
plotDiffContours: Plots the difference between two years from a contour plot...
plotFlowSingle: Creates a plot of a time series of a particular flow...
plotFluxHist: Graph of annual flux and flow normalized flux versus year
plotFluxPred: Graph of observed versus estimated flux
plotFluxQ: Sample data plot: observed log flux vs log discharge
plotFluxTimeDaily: Plot of the time series of daily flux estimates and the...
plotFour: Makes four graphs of streamflow statistics on a single page
plotFourStats: Makes four graphs of annual streamflow statistics on a single...
plotQTimeDaily: Plot of the discharge time series
plotResidPred: Plot of the residuals from WRTDS versus the estimated values...
plotResidQ: Plot of the residuals from WRTDS (in log concentration units)...
plotResidTime: Plot of the residuals from WRTDS (in log concentration units)...
plotSDLogQ: Graph of the standard deviation of the log of daily discharge...
populateConcentrations: Populate Concentration Columns
populateDaily: Populate Daily data frame
populateDateColumns: Populate Date Columns
populateParameterINFO: Populate Parameter Information Columns
populateSampleColumns: Populate Sample Columns
populateSiteINFO: Populate Site Information Columns
print.egret: Prints EGRET object
printFluxUnitCheatSheet: Available Flux Unit properties
printqUnitCheatSheet: Available Flow Unit properties
printSeries: Print annual results for a given streamflow statistic
processQWData: Processing of USGS NWIS Water Quality Data
qUnit-class: qUnit class
readDataFromFile: Basic Data Import for Water Flow Data
readNWISDaily: Import NWIS Daily Data for EGRET analysis
readNWISSample: Import NWIS Sample Data for EGRET analysis
readUserDaily: Import user daily data for EGRET analysis
readUserSample: Import user sample data for EGRET analysis
readWQPSample: Import Sample Data for WRTDS
removeDuplicates: Remove Duplicates
runSurvReg: Run the weighted survival regression for a set of estimation...
sampleData: Example eList
saveResults: A utility program for saving the contents of the workspace...
selectDays: Creates a subset data frame that only contains data for the...
setPA: Sets up the period of analysis
setSeasonLabel: Create a character character that describes the period of...
setSeasonLabelByUser: Creates a character character that describes the period of...
setUpEstimation: setUpEstimation
setupYears: Creates the AnnualResults data frame from the Daily data...
surfaceIndex: Compute the 6 parameters needed to lay out the grid for the...
tableChange: Create a table of the changes in flow-normalized values...
tableChangeSingle: Create a table of the changes in flow-normalized...
tableFlowChange: Prints table of change metrics for a given streamflow...
tableResults: Table of annual results for discharge, concentration and flux
triCube: Tricube weight function
yPretty: Sets up tick marks for an axis for a graph with an arithmetic...

Functions

Arkansas_eList Man page
Choptank_eList Man page
Constants Man page
EGRET-package Man page
INFOdataframe Man page
as.egret Man page Source code
blankTime Man page Source code
boxConcMonth Man page Source code
boxConcThree Man page Source code
boxQTwice Man page Source code
boxResidMonth Man page Source code
calculateMonthlyResults Man page Source code
censoredSegments Man page Source code
checkStartEndDate Man page Source code
compressData Man page Source code
dataOverview Man page Source code
dateFormatCheck Man page Source code
estCrossVal Man page Source code
estDailyFromSurfaces Man page Source code
estSurfaces Man page Source code
fixSampleFrame Man page Source code
flowDuration Man page Source code
fluxBiasMulti Man page Source code
fluxBiasStat Man page Source code
fluxConst Man page
fluxUnit-class Man page
formatCheckDate Man page Source code
formatCheckParameterCd Man page Source code
generalAxis Man page Source code
genericEGRETDotPlot Man page Source code
getDaily Man page Source code
getDaily.default Man page Source code
getDaily.egret Man page Source code
getInfo Man page Source code
getInfo.default Man page Source code
getInfo.egret Man page Source code
getSample Man page Source code Source code
getSample.default Man page Source code
getSurfaces Man page Source code
getSurfaces.default Man page Source code
getSurfaces.egret Man page Source code
is.egret Man page Source code
logPretty1 Man page Source code
logPretty3 Man page Source code
makeAnnualSeries Man page Source code
makeAugmentedSample Man page Source code
mergeReport Man page Source code
modelEstimation Man page Source code
monthInfo Man page
monthLabel-class Man page
multiPlotDataOverview Man page Source code
plot15 Man page Source code
plot1of15 Man page Source code
plotConcHist Man page Source code
plotConcPred Man page Source code
plotConcQ Man page Source code
plotConcQSmooth Man page Source code
plotConcTime Man page Source code
plotConcTimeDaily Man page Source code
plotConcTimeSmooth Man page Source code
plotContours Man page Source code
plotDiffContours Man page Source code
plotFlowSingle Man page Source code
plotFluxHist Man page Source code
plotFluxPred Man page Source code
plotFluxQ Man page Source code
plotFluxTimeDaily Man page Source code
plotFour Man page Source code
plotFourStats Man page Source code
plotQTimeDaily Man page Source code
plotResidPred Man page Source code
plotResidQ Man page Source code
plotResidTime Man page Source code
plotSDLogQ Man page Source code
populateConcentrations Man page Source code
populateDaily Man page Source code
populateDateColumns Man page Source code
populateParameterINFO Man page Source code
populateSampleColumns Man page Source code
populateSiteINFO Man page Source code
print.egret Man page Source code
printFluxUnitCheatSheet Man page Source code
printSeries Man page Source code
printqUnitCheatSheet Man page Source code
processQWData Man page Source code
qConst Man page
qUnit-class Man page
readDataFromFile Man page Source code
readNWISDaily Man page Source code
readNWISInfo Man page Source code
readNWISSample Man page Source code
readUserDaily Man page Source code
readUserInfo Man page Source code
readUserSample Man page Source code
readWQPInfo Man page Source code
readWQPSample Man page Source code
removeDuplicates Man page Source code
runSurvReg Man page Source code
saveResults Man page Source code
selectDays Man page Source code
setPA Man page Source code
setSeasonLabel Man page Source code
setSeasonLabelByUser Man page Source code
setUpEstimation Man page Source code
setupYears Man page Source code
surfaceIndex Man page Source code
tableChange Man page Source code
tableChangeSingle Man page Source code
tableFlowChange Man page Source code
tableResults Man page Source code
triCube Man page Source code
yPretty Man page Source code

Files

inst
inst/CITATION
inst/extdata
inst/extdata/ChoptankRiverFlow.txt
inst/extdata/eListMerced.RData
inst/extdata/ChoptankRiverNitrate.csv
inst/extdata/eListColumbia.RData
inst/extdata/eListMiss.RData
inst/extdata/infoTest.csv
inst/doc
inst/doc/rResid.Rmd
inst/doc/EGRET.R
inst/doc/rResid.html
inst/doc/rResid.R
inst/doc/EGRET.Rnw
inst/doc/EGRET.pdf
tests
tests/testthat.R
tests/testthat
tests/testthat/tests_imports.R
NAMESPACE
demo
demo/checkData.R
demo/WRTDSanalysis.R
demo/FlowHistory.R
demo/00Index
NEWS
data
data/Arkansas_eList.RData
data/Choptank_eList.RData
data/datalist
R
R/genericEGRETplot.R
R/logPretty3.R
R/modelEstimation.R
R/printqUnitCheatSheet.R
R/makeAnnualSeries.R
R/removeDuplicates.r
R/readMetaData.r
R/populateSampleColumns.r
R/readNWISSample.r
R/printFluxUnitCheatSheet.R
R/plotResidQ.R
R/makeRandomResiduals.R
R/selectDays.R
R/populateDateColumns.r
R/logPretty1.R
R/readDataFromFile.r
R/plotConcQSmooth.R
R/processQWData.r
R/fluxUnit.R
R/plotContours.R
R/printSeries.R
R/populateConcentrations.r
R/triCube.R
R/plotFluxQ.R
R/censoredSegments.R
R/estCrossVal.R
R/plotConcTimeDaily.R
R/plotConcTimeSmooth.R
R/plotFluxHist.R
R/tableChangeSingle.R
R/sysdata.rda
R/setSeasonLabel.R
R/checkStartEndDate.r
R/formatCheckDate.r
R/plotResidPred.R
R/EGRET.R
R/tableFlowChange.R
R/plotFlowSingle.R
R/tableResults.R
R/boxResidMonth.R
R/boxConcMonth.R
R/readWQPSample.R
R/multiPlotDataOverview.R
R/fixSampleFrame.R
R/readUserSample.r
R/estSurfaces.R
R/plot1of15.R
R/plotConcTime.R
R/generalAxis.R
R/plotDiffContours.R
R/fluxBiasEight.R
R/plotResidTime.R
R/plotFluxTimeDaily.R
R/plotFluxPred.R
R/plotConcHist.R
R/boxQTwice.R
R/setSeasonLabelByUser.R
R/yPretty.R
R/calculateMonthlyResults.R
R/compressData.r
R/plotFourStats.R
R/plotQTimeDaily.R
R/readUserDaily.r
R/readNWISDaily.r
R/populateSiteINFO.r
R/tableChange.R
R/saveResults.R
R/setupYears.R
R/surfaceIndex.R
R/runSurvReg.R
R/formatCheckParameterCd.r
R/populateParameterINFO.r
R/plotFour.R
R/mergeReport.r
R/blankTime.R
R/dataOverview.r
R/fluxBiasStat.R
R/objectDefinitions.R
R/plot15.R
R/flowDuration.R
R/plotConcQ.R
R/populateDaily.r
R/plotSDLogQ.R
R/estDailyFromSurfacesJ.R
R/setPA.R
R/boxConcThree.R
R/plotConcPred.R
R/dateFormatCheck.r
vignettes
vignettes/table1.png
vignettes/rResid.Rmd
vignettes/EGRET.Rnw
README.md
MD5
build
build/vignette.rds
DESCRIPTION
LICENSE.note
man
man/print.egret.Rd
man/plotFluxPred.Rd
man/triCube.Rd
man/setSeasonLabelByUser.Rd
man/populateDaily.Rd
man/plotConcPred.Rd
man/makeAugmentedSample.Rd
man/plotResidPred.Rd
man/plotSDLogQ.Rd
man/dataOverview.Rd
man/multiPlotDataOverview.Rd
man/plotContours.Rd
man/plotConcTimeDaily.Rd
man/populateParameterINFO.Rd
man/plotFluxQ.Rd
man/getInfo.Rd
man/fluxUnit-class.Rd
man/boxConcThree.Rd
man/setupYears.Rd
man/mergeReport.Rd
man/dateFormatCheck.Rd
man/plotConcQ.Rd
man/populateSiteINFO.Rd
man/tableResults.Rd
man/compressData.Rd
man/tableFlowChange.Rd
man/plotFour.Rd
man/monthLabel-class.Rd
man/modelEstimation.Rd
man/readNWISDaily.Rd
man/estDailyFromSurfaces.Rd
man/qUnit-class.Rd
man/plotConcQSmooth.Rd
man/plotConcTimeSmooth.Rd
man/populateSampleColumns.Rd
man/setPA.Rd
man/generalAxis.Rd
man/plot1of15.Rd
man/plot15.Rd
man/Constants.Rd
man/getSample.Rd
man/boxQTwice.Rd
man/censoredSegments.Rd
man/tableChange.Rd
man/makeAnnualSeries.Rd
man/readDataFromFile.Rd
man/fluxBiasMulti.Rd
man/plotFluxHist.Rd
man/printSeries.Rd
man/as.egret.Rd
man/calculateMonthlyResults.Rd
man/selectDays.Rd
man/fluxBiasStat.Rd
man/is.egret.Rd
man/plotConcHist.Rd
man/plotResidTime.Rd
man/plotFlowSingle.Rd
man/boxConcMonth.Rd
man/setUpEstimation.Rd
man/processQWData.Rd
man/populateDateColumns.Rd
man/INFOdataframe.Rd
man/printFluxUnitCheatSheet.Rd
man/populateConcentrations.Rd
man/removeDuplicates.Rd
man/setSeasonLabel.Rd
man/plotDiffContours.Rd
man/EGRET-package.Rd
man/readUserDaily.Rd
man/formatCheckParameterCd.Rd
man/getDaily.Rd
man/readUserSample.Rd
man/plotResidQ.Rd
man/readWQPSample.Rd
man/printqUnitCheatSheet.Rd
man/plotFourStats.Rd
man/blankTime.Rd
man/getSurfaces.Rd
man/yPretty.Rd
man/estCrossVal.Rd
man/formatCheckDate.Rd
man/flowDuration.Rd
man/logPretty3.Rd
man/genericEGRETDotPlot.Rd
man/saveResults.Rd
man/surfaceIndex.Rd
man/fixSampleFrame.Rd
man/boxResidMonth.Rd
man/tableChangeSingle.Rd
man/estSurfaces.Rd
man/plotQTimeDaily.Rd
man/logPretty1.Rd
man/runSurvReg.Rd
man/checkStartEndDate.Rd
man/readNWISSample.Rd
man/plotFluxTimeDaily.Rd
man/plotConcTime.Rd
man/sampleData.Rd
EGRET documentation built on May 19, 2017, 11:05 p.m.

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.

Please suggest features or report bugs in the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.