README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "75%"
)
```

# nwmTools <img src="man/figures/logo.png" width=130 height = 130 align="right" />

<!-- badges: start -->
[![Dependencies](https://img.shields.io/badge/dependencies-11/65-red?style=flat)](#)
[![LifeCycle](man/figures/lifecycle/lifecycle-experimental.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![Website deployment](https://github.com/mikejohnson51/nwmTools/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/mikejohnson51/nwmTools/actions/workflows/pkgdown.yaml)
[![R CMD Check](https://github.com/mikejohnson51/nwmTools/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/mikejohnson51/nwmTools/actions/workflows/R-CMD-check.yaml)
[![Project Status: Concept](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept)
[![codecov](https://codecov.io/gh/mikejohnson51/nwmTools/branch/master/graph/badge.svg?token=H5YHXYZ1WH)](https://codecov.io/gh/mikejohnson51/nwmTools)
<!-- badges: end -->

# Description

`nwmTools` facilitates access to NOAA National Water Model operational and historic data through a convenient API.

# Features

 * Build and query operational NWM channel output by feature
 * Access historic NWM Reanalysis v1.2, 2.0, or 2.1 data by feature 
 * Data requests can be constrained temporally, and adjusted for timezone
 * Plays nicely with functionality within `nhdplusTools` and `dataRetrieval`
 * Family of aggregate functions to summarize data along time-based aggregates
 
## Installation

```{r, eval = FALSE}
remotes::install_github('mikejohnson51/nwmTools')
```


# Data Documentation:

[HydroShare](https://www.hydroshare.org/resource/89b0952512dd4b378dc5be8d2093310f/)

# Support:

This effort is supported by the Consortium of Universities for the Advancement of Hydrologic Science, Inc. under the 2020 HydroInformatics Fellowship. See program [here](https://www.cuahsi.org/data-models/hydroinformatics-innovation-fellowship/)