-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathREADME.Rmd
85 lines (56 loc) · 3.37 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
options(width=100)
knitr::opts_chunk$set(
# collapse = TRUE,
# comment = "#>",
# fig.path = "man/figures/",
# out.width = "100%"
)
```
# hydrofab: Fabricating Hydrofabrics <img src='man/figures/imgfile.png' align="right" height="139" />
<!-- badges: start -->
[](https://github.com/mikejohnson51/hydrofab/actions/workflows/R-CMD-check.yml)
[](#)
<!-- badges: end -->
The goal of `hydrofab` is to provide consistent hydrologic and hydraulic network manipulation tool chains to achieve model application ready datasets from a consistent reference fabric. Some of these are being built at [ngen.hydrofab](https://github.com/mikejohnson51/ngen.hydrofab) and [gfv2.0](https://code.usgs.gov/wma/nhgf/gfv2.0)
## Installation
You can install the development version of hydrofab like so:
```{r eval = FALSE}
install.packages("remotes")
remotes::install_github("mikejohnson51/hydrofab")
```
## Introduction
This package is based around the same concepts as [nhdplusTools](https://usgs-r.github.io/nhdplusTools/) in an attempt to provide a common software stack for fabricating hydrofabrics.
### Refactoring and Aggregating
The concept of refactoring as intended here includes:
1) **Splitting** large or long catchments to create a more uniform catchment size
distribution,
2) **collapsing** catchment topology to eliminate small catchments
The concept of aggregating as intended here includes **aggregating** catchments into groups based on existing network topology and defined criteria. Two primary use cases are offered:
1. Aggregating to a set of defined outlet locations
2. Merging catchments to a uniform size with enforced minimum areas and lengths.
This type of functionality is especially relevant to modeling applications that
need specific modeling unit characteristics but wish to preserve the network as
much as possible for interoperability with other applications
```{r, eval = FALSE, echo = FALSE}
# knitr::include_graphics(c("man/figures/lynker-logo.png","man/figures/noaa-logo.png", 'man/figures/usgs-logo.png'))
# library(cowplot)
# xx = ggdraw() +
# draw_image("man/figures/usgs-logo.png", width = 0.33, height = .25, y = .05) +
# draw_image("man/figures/noaa-logo.png", width = 0.33, height = .35, x = 0.33) +
# draw_image("man/figures/lynker-logo.png", width = 0.33, height = .25, x = .66, y = .05)
#
# cowplot::save_plot(xx, filename = "man/figures/logos.png")
```
```{r, fig.align='center', echo = FALSE}
knitr::include_graphics("man/figures/logos.png")
```
## Questions:
<a href = "mailto:[email protected]?subject=Nexgen Hydrofabric Questions">
Mike Johnson</a> (NOAA Hydrofabric Lead)
## Disclaimer
These data are preliminary or provisional and are subject to revision. They are being provided to meet the need for timely best science. The data have not received final approval by the National Oceanic and Atmospheric Administration (NOAA) or the U.S. Geological Survey (USGS) and are provided on the condition that neither NOAA, the USGS, nor the U.S. Government shall be held liable for any damages resulting from the authorized or unauthorized use of the data.