Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
LICENSE
.travis.yml
.lintr
inst/doc/*.html
docs
_pkgdown.yml
data-raw
Expand All @@ -29,3 +28,6 @@ revdep
CLAUDE.md
dev
.claude
inst/build
vignettes/drainage_area_figures
PLAN.md
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
* text=auto

pkgdown/assets/slides/3dhp_tools_gwtc_2026.html linguist-vendored
1 change: 0 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ Depends:
R (>= 4.1)
Imports: hydroloom, dataRetrieval, dplyr, sf, units, magrittr, jsonlite, httr, xml2, R.utils, utils, tidyr, methods, maptiles, mapsf, fst, arrow, tools, zip, pbapply, memoise, digest
Suggests: testthat, knitr, rmarkdown, ggmap, ggplot2, lwgeom, gifski, leaflet, httptest, future, future.apply, StreamCatTools, terra
Remotes: doi-usgs/hydroloom
License: CC0
Encoding: UTF-8
RoxygenNote: 7.3.3
Expand Down
13 changes: 8 additions & 5 deletions DISCLAIMER.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
Disclaimer
==========

This software has been approved for release by the U.S. Geological Survey (USGS). Although the software has been subjected to rigorous review, the USGS reserves the right to update the software as needed pursuant to further analysis and review. No warranty, expressed or implied, is made by the USGS or the U.S. Government as to the functionality of the software and related material nor shall the fact of release constitute any such warranty. Furthermore, the software is released on condition that neither the USGS nor the U.S. Government shall be held liable for any damages resulting from its authorized or unauthorized use.

From: https://www2.usgs.gov/fsp/fsp_disclaimers.asp#5

This software is in the public domain because it contains materials that originally came from the U.S. Geological Survey, an agency of the United States Department of Interior. For more information, see the [official USGS copyright policy](https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits "official USGS copyright policy")
This software is preliminary or provisional and is subject to revision. It is
being provided to meet the need for timely best science. The software has not
received final approval by the U.S. Geological Survey (USGS). No warranty,
expressed or implied, is made by the USGS or the U.S. Government as to the
functionality of the software and related material nor shall the fact of release
constitute any such warranty. The software is provided on the condition that
neither the USGS nor the U.S. Government shall be held liable for any damages
resulting from the authorized or unauthorized use of the software.
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
nhdplusTools 1.5.0
==========

nhdplusTools 1.5.0 will be the last minor release of nhdplusTools before the package is renamed. Path releases may occur to fix minor issues or change things necessary for the name change, but the API is effectively frozen and all new dvelopment will go toward the replacement package `hydrogeofetch`. For more, see the README.md.
nhdplusTools 1.5.0 will be the last minor release of nhdplusTools before the package is renamed. Path releases may occur to fix minor issues or change things necessary for the name change, but the API is effectively frozen and all new development will go toward the replacement package `hydrogeofetch`. For more, see the README.md.

This release adds drainage area estimation tooling that combines HUC12 areas with NHDPlusV2 catchments to produce drainage area estimates at arbitrary points on the network.

Expand Down
6 changes: 3 additions & 3 deletions R/downloading_tools.R
Original file line number Diff line number Diff line change
Expand Up @@ -265,9 +265,9 @@ download_rf1 <- function(outdir,

message("Extracting data ...")

R.utils::gunzip(file, remove = FALSE, skip = T)
R.utils::gunzip(file, remove = FALSE, skip = TRUE)

path <- list.files(outdir, full.names = T)[!grepl("gz", list.files(outdir))]
path <- list.files(outdir, full.names = TRUE)[!grepl("gz", list.files(outdir))]
path <- path[grepl("rf1", path)]

message(paste("RF1 data extracted to:", path))
Expand All @@ -291,7 +291,7 @@ download_rf1 <- function(outdir,
downloader <- function(dir, url, type, progress = TRUE){

if (!dir.exists(dir)) {
dir.create(dir, recursive = T)
dir.create(dir, recursive = TRUE)
}

file <- file.path(dir, basename(url))
Expand Down
10 changes: 10 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,16 @@ Given this, the package should be built locally to include vignettes using:
devtools::build()
```

An additional CRAN build environment variable also must be set to avoid submitting a vignette with very large embedded images.

```r
Sys.setenv(BUILD_VIGNETTES = "TRUE", BUILD_VIGNETTES_CRAN = "TRUE")
devtools::build()


devtools::release()
```

### Check notes:
In addition to typical R package checking, a Dockerfile is included in this repository. Once built, it can be run with the following command.

Expand Down
49 changes: 26 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ Downloads](https://cranlogs.r-pkg.org/badges/grand-total/nhdplusTools)](https://

## Renaming to `hydrogeofetch`

`nhdplusTools` is being renamed to `hydrogeofetch` (hydrologic geospatial
fabric extraction tool chain). The package’s scope has grown beyond
NHDPlus, and the name is no longer accurate. `hydrogeofetch` will be a
pure rename. Functions, function signatures, behavior, will all stay the
same. `hydrogeofetch` will be published to CRAN as a new package.
`nhdplusTools` is being renamed to `hydrogeofetch` (hydrologic
geospatial fabric extraction tool chain). The package’s scope has grown
beyond NHDPlus, and the name is no longer accurate. `hydrogeofetch` will
be a pure rename. Functions, function signatures, behavior, will all
stay the same. `hydrogeofetch` will be published to CRAN as a new
package.

Development on `nhdplusTools` has stopped; only critical bug fixes will
be applied. Once `hydrogeofetch` v1.0 is released, `nhdplusTools` will
Expand Down Expand Up @@ -208,6 +209,17 @@ using:
devtools::build()
```

An additional CRAN build environment variable also must be set to avoid
submitting a vignette with very large embedded images.

``` r
Sys.setenv(BUILD_VIGNETTES = "TRUE", BUILD_VIGNETTES_CRAN = "TRUE")
devtools::build()


devtools::release()
```

### Check notes:

In addition to typical R package checking, a Dockerfile is included in
Expand Down Expand Up @@ -262,23 +274,14 @@ documentation. - this package uses pkgdown. Running

# Disclaimer

This software has been approved for release by the U.S. Geological
Survey (USGS). Although the software has been subjected to rigorous
review, the USGS reserves the right to update the software as needed
pursuant to further analysis and review. No warranty, expressed or
implied, is made by the USGS or the U.S. Government as to the
functionality of the software and related material nor shall the fact of
release constitute any such warranty. Furthermore, the software is
released on condition that neither the USGS nor the U.S. Government
shall be held liable for any damages resulting from its authorized or
unauthorized use.

From: <https://www2.usgs.gov/fsp/fsp_disclaimers.asp#5>

This software is in the public domain because it contains materials that
originally came from the U.S. Geological Survey, an agency of the United
States Department of Interior. For more information, see the [official
USGS copyright
policy](https://www.usgs.gov/information-policies-and-instructions/copyrights-and-credits "official USGS copyright policy")
This software is preliminary or provisional and is subject to revision.
It is being provided to meet the need for timely best science. The
software has not received final approval by the U.S. Geological Survey
(USGS). No warranty, expressed or implied, is made by the USGS or the
U.S. Government as to the functionality of the software and related
material nor shall the fact of release constitute any such warranty. The
software is provided on the condition that neither the USGS nor the U.S.
Government shall be held liable for any damages resulting from the
authorized or unauthorized use of the software.

[![CC0](https://i.creativecommons.org/p/zero/1.0/88x31.png)](https://creativecommons.org/publicdomain/zero/1.0/)
2 changes: 1 addition & 1 deletion docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 25 additions & 4 deletions docs/CLAUDE.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 2 additions & 4 deletions docs/DISCLAIMER.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/LICENSE.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion docs/articles/drainage_area_estimation.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/articles/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/articles/nhdplushr.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file modified docs/articles/nhdplushr_files/figure-html/plot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/articles/nhdplushr_files/figure-html/tldr-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/authors.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading