Overview and installation - USGS-R/WQ-Review GitHub Wiki

#Introduction Toolbox for discrete water-quality data review and exploration.Users are encouraged to post any bugs or comments for additional functionality on the issues page at:

WQ-Review Issues.

This package facilitates data review and exploration of discrete water-quality data through rapid and easy-to-use plotting functions and tabular data summaries. Data is imported with user-specified options for single or multiple sites and parameter codes using an ODBC connection to the user's local NWIS server. A graphical user interface allows the user to easily explore their data through a variety of graphical and tabular outputs.

Screenshot

##Requirements

  • This application requires a functioning 32 bit ODBC connection to an NWIS server. Guidance for setting up ODBC access is provided at the bottom of this page.
  • Google Chrome is required and must be set as the system default browser.

##Bug reporting and enhancements Please report any issues with the application or R package on the issues page at:

WQ-Review Issues.

Additionaly, please feel free to post any suggestions or enhancement requests.

Your participation will make this a better tool for everyone!

##Installation for stand alone application (non-R users)

  1. Download the application at

ftp://ftpint.usgs.gov/private/cr/co/lakewood/tmills/wqReviewSetup.exe

  1. Run wqReviewSetup.exe and follow the installation instructions.

DO NOT INSTALL WQ-REVIEW INTO YOUR PROGRAM FILES DIRECTORY OR THE APPLICATION WILL NOT RUN. INSTALL TO C DRIVE OR YOUR DOCUMENTS FOLDER.

  1. Update WQ-Review to the latest version either by clicking the checkbox at the end of the setup, or by going to Startmenu->Programs->WQ-Review->Update. A command prompt window will appear and stay open until the update is complete. When the update is complete it will close with no other prompts.

##Installation for R users ###Step 1. Switch over to 32-bit R.

R must be run in 32-bit mode to use the ODBC driver. Open R-studio and click Tools-Global Options on the top toolbar. Under "General" in the global options dialog, you will see "R version:" at the top. Click "Change" next to the R version and select "Use your machine's default version of R (32 bit)" to change to 32-bit R. R-studio will need to restart after doing this.

###Step 2. Install the "devtools" package for installing WQ-Review directly from Github.

Open R-studio in 32-bit mode if it is not already open and type the following command in the console:

install.packages(c("curl","devtools"))

This will install the devtools package on your machine.

If an error appears about "Rtools not installed", ignore this message, Rtools is not required for the devtools functions you will use.

###Step 3. Install the WQ-Review package from Github.

Open R-studio in 32-bit mode if it is not already open and type the following commands in the console:

library(devtools)
install_github("USGS-R/WQ-Review",build_vignettes = TRUE)

This will install the WQ-Review package as well as all other packages that WQ-Review relies on. It may take a minute to download and install the supporting packages during the first installation.

###Run the app The shiny app is launched by loading the WQ-Review package and running the function

library(WQReview)
WQReviewGUI()