Skip to content

Commit

Permalink
update readme and version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
mikejohnson51 committed May 14, 2024
1 parent 8a1ac09 commit 52448a1
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 28 deletions.
15 changes: 8 additions & 7 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: hydrofab
Type: Package
Title: Hydrologic Network Refactoring and Aggregation Tools
Version: 0.5.1
Version: 0.5.2
Authors@R: c(person(given = "Mike", family = "Johnson",
role = c("aut", "cre"),
comment = c(ORCID = "0000-0002-5288-8350"),
Expand All @@ -15,33 +15,34 @@ BugReports: https://github.com/mikejohnson51/hydrofab/issues
Depends:
R (>= 3.5.0)
Imports:
climateR,
data.table,
DBI,
dplyr,
glue,
httr,
hydroloom,
igraph,
jsonlite,
logger,
lwgeom,
methods,
nhdplusTools,
parallel,
pbapply,
rlang,
RSQLite,
rmapshaper,
RSQLite,
rvest,
sf,
terra,
tibble,
tidyr,
units,
utils
Suggests:
knitr,
rmarkdown,
testthat,
tibble
testthat
Remotes:
mikejohnson51/climateR
License: CC0
Encoding: UTF-8
LazyData: true
Expand Down
13 changes: 4 additions & 9 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ knitr::opts_chunk$set(
# hydrofab: Fabricating Hydrofabrics <img src='man/figures/imgfile.png' align="right" height="139" />

<!-- badges: start -->
[![Dependencies](https://img.shields.io/badge/dependencies-19/80-red?style=flat)](#)
[![R CMD Check](https://github.com/mikejohnson51/hydrofab/actions/workflows/R-CMD-check.yml/badge.svg)](https://github.com/mikejohnson51/hydrofab/actions/workflows/R-CMD-check.yml)
[![Dependencies](https://img.shields.io/badge/dependencies-21/80-red?style=flat)](#)
<!-- 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)
Expand All @@ -32,16 +33,10 @@ install.packages("remotes")
remotes::install_github("mikejohnson51/hydrofab")
```

Soon to be ...

```{r eval = FALSE}
remotes::install_github("NOAA-OWP/hydrofab")
```

## Introduction

This package is based around the same concepts as [nhdplusTools](https://usgs-r.github.io/nhdplusTools/) and merges the
previous `hyRefactor` and `hyAggregate` packages in an attempt to provide a common software stack for fabricating hydrofabrics.
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

Expand Down Expand Up @@ -80,7 +75,7 @@ knitr::include_graphics("man/figures/logos.png")
## Questions:

<a href = "mailto:[email protected]?subject=Nexgen Hydrofabric Questions">
Mike Johnson</a> (NOAA Hydrofabric Lead), <a href = "mailto:[email protected]?subject=Nexgen Hydrofabric Questions"> David L. Blodgett </a> (Hydroinformatics Lead, USGS WMA)
Mike Johnson</a> (NOAA Hydrofabric Lead)


## Disclaimer
Expand Down
17 changes: 5 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@

<!-- badges: start -->

[![Dependencies](https://img.shields.io/badge/dependencies-19/80-red?style=flat)](#)
[![R CMD
Check](https://github.com/mikejohnson51/hydrofab/actions/workflows/R-CMD-check.yml/badge.svg)](https://github.com/mikejohnson51/hydrofab/actions/workflows/R-CMD-check.yml)
[![Dependencies](https://img.shields.io/badge/dependencies-21/80-red?style=flat)](#)
<!-- badges: end -->

The goal of `hydrofab` is to provide consistent hydrologic and hydraulic
Expand All @@ -23,17 +25,10 @@ install.packages("remotes")
remotes::install_github("mikejohnson51/hydrofab")
```

Soon to be …

``` r
remotes::install_github("NOAA-OWP/hydrofab")
```

## Introduction

This package is based around the same concepts as
[nhdplusTools](https://usgs-r.github.io/nhdplusTools/) and merges the
previous `hyRefactor` and `hyAggregate` packages in an attempt to
[nhdplusTools](https://usgs-r.github.io/nhdplusTools/) in an attempt to
provide a common software stack for fabricating hydrofabrics.

### Refactoring and Aggregating
Expand Down Expand Up @@ -62,9 +57,7 @@ other applications
## Questions:

<a href = "mailto:[email protected]?subject=Nexgen Hydrofabric Questions">
Mike Johnson</a> (NOAA Hydrofabric Lead),
<a href = "mailto:[email protected]?subject=Nexgen Hydrofabric Questions">
David L. Blodgett </a> (Hydroinformatics Lead, USGS WMA)
Mike Johnson</a> (NOAA Hydrofabric Lead)

## Disclaimer

Expand Down

0 comments on commit 52448a1

Please sign in to comment.