Home

Overview

---

### Installation Instructions 1. [Install and Configure Postgresql](https://github.com/Kevin-M-Smith/nwisnfie/wiki/Install-and-Configure-Postgresql) 2. [Install Dependencies](https://github.com/Kevin-M-Smith/nwisnfie/wiki/Install-Dependencies) 3. [Install R Packages](https://github.com/Kevin-M-Smith/nwisnfie/wiki/Install-R-Packages) 4. [Final Installation and Configuration](https://github.com/Kevin-M-Smith/nwisnfie/wiki/Final-Installation-and-Configuration)

---

### Common Usage

---

### Function Documentation Currently documentation is only available for exported functions (i.e. function visible to the user after calling `library(nwisnfie)`. Non-exported functions are used to handle internal operations and are not made available to the user.

In-session Documentation

In session documentation can be accessed by preceding the function of concern with a ? mark.

?RunQuery

Tab Completion

If tab-completion is enabled, hitting the tab twice key after typing, for example, RunQuery( should offer a list of the possible arguments.

Other Documentation

• List of Exported Functions _@TODO
• PDF Documentation
• Complete Function Index

---

### For Developers #### Building PDF Documentation

From the nwisnfie package directory, run:

rm inst/etc/man/nwisnfie.pdf
R CMD Rd2pdf . --output="inst/etc/man/nwisnfie.pdf"

Set Up a Development Environment:

1. Install RStudio
2. Install the devtools package from CRAN
3. Clone this repository: git clone https://github.com/Kevin-M-Smith/nwisnfie.git
4. Open the nwisnfie.Rproj file in the cloned directory with RStudio.