return vector from hydroseq, remove docs

Author: mikejohnson51

NAMESPACE

@@ -6,9 +6,9 @@ S3method(dbplyr_edition,OGRSQLConnection)
 S3method(st_as_sf,tbl_OGRSQLConnection)
 export(OGRSQL)
 export(accumulate_downstream)
-export(add_hydroseq)
 export(as_ogr)
 export(collect)
+export(get_hydroseq)
 export(st_as_sf)
 exportClasses(OGRSQLConnection)
 exportClasses(OGRSQLDriver)

R/network_properties.R

@@ -5,7 +5,7 @@
 #' input row. The network must be a DAG (no cycles). This is an O(E) pass after
 #' a single topological sort and is fast on large hydro networks.
 #'
-#' @param x A data frame (or tibble) containing at least the identifier column
+#' @param x A data frame, tibble, or sf object containing at least the identifier column
 #'   given by `id`, the downstream pointer column given by `toid`, and the
 #'   attribute column named in `attr`.
 #' @param id Character scalar. Column name in `x` with unique node identifiers.
@@ -95,7 +95,7 @@ accumulate_downstream <- function(x, id   = "flowpath_id", toid = "flowpath_toid
 
 #' Compute and add the hydrosequence to a directed acyclic network.
 #'
-#' @param topology A data frame (or tibble) containing at least the identifier column
+#' @param x A data frame (or tibble) containing at least the identifier column
 #'   given by `id` and the downstream pointer column given by `toid`.
 #' @param id Character scalar. Column name in `topology` with unique node identifiers.
 #'   Defaults to `"flowpath_id"`.
@@ -109,14 +109,14 @@ accumulate_downstream <- function(x, id   = "flowpath_id", toid = "flowpath_toid
 #' @importFrom igraph dfs graph_from_data_frame
 #' @export
 
-add_hydroseq <- function(topology, id = "flowpath_id", toid = "flowpath_toid", colname = "hydroseq") {
+get_hydroseq <- function(x, id = "flowpath_id", toid = "flowpath_toid") {
   # Create a _transposed_ network, where traversing the network
   # is equivalent to traversing the hydrological network upstream.
   #
   # This assumes the outlets of this network all connect to an
   # ephemeral "0" node (forming a rooted tree network).
 
-  edgelist <- as.data.frame(topology)[, c(toid, id)]
+  edgelist <- as.data.frame(x)[, c(toid, id)]
   names(edgelist) <- c("id", "toid")
   edgelist$id[is.na(edgelist$id)] <- "0"
 
@@ -147,8 +147,7 @@ add_hydroseq <- function(topology, id = "flowpath_id", toid = "flowpath_toid", c
   names(result) <- c(id, toid, "hydroseq")
 
   # Arrange into input order
-  topology[[colname]] <- result$hydroseq[match(topology[[id]], result[[id]])]
-  topology
+  result$hydroseq[match(x[[id]], result[[id]])]
 }
 
 

README.Rmd

@@ -35,7 +35,7 @@ You can install the development version of `hfutils` from [GitHub](https://githu
 remotes::install_github("lynker-spatial/hfutils")
 ```
 
-```{r}
+```{r,message=FALSE}
 library(hfutils)
 library(dplyr)
 ```
@@ -47,26 +47,27 @@ library(dplyr)
 #### Basic connection: Dataset
 
 ```{r, eval = TRUE}
-hfutils::as_ogr('/Users/mikejohnson/hydrofabric/v3.0/reference_fabric.gpkg')
+gpkg <- '/Users/mikejohnson/hydrofabric/v3.0/reference_fabric.gpkg'
+hfutils::as_ogr(gpkg)
 ```
 
 #### Basic connection: Layer
 
 ```{r, eval = TRUE}
-hfutils::as_ogr('/Users/mikejohnson/hydrofabric/v3.0/reference_fabric.gpkg', "divides") 
+hfutils::as_ogr(gpkg, "divides") 
 ```
 
 #### Lazy Eval
 
 ```{r, eval = TRUE}
-hfutils::as_ogr('/Users/mikejohnson/hydrofabric/v3.0/reference_fabric.gpkg', "divides") |> 
+hfutils::as_ogr(gpkg, "divides") |> 
   select(divide_id, areasqkm) 
 ```
 
 #### sf extraction
 
 ```{r, eval = TRUE}
-hfutils::as_ogr('/Users/mikejohnson/hydrofabric/v3.0/reference_fabric.gpkg', "divides")  |> 
+hfutils::as_ogr(gpkg, "divides")  |> 
   filter(vpuid == "01") |> 
   st_as_sf()
 ```
@@ -82,7 +83,7 @@ hfutils::as_ogr('/vsis3/lynker-spatial/hydrofabric/v2.2/conus/conus_nextgen.gpkg
 ```{r}
 ## Accumulate Downstream
 system.time({
-  da <-  hfutils::as_ogr('/Users/mikejohnson/hydrofabric/v3.0/reference_fabric.gpkg', 
+  da <-  hfutils::as_ogr(gpkg, 
                          'flowpaths')  |> 
   filter(vpuid == "01") |> 
   st_as_sf() |> 
@@ -92,14 +93,14 @@ head(da)
 
 ## Hydrosequence
 system.time({
-  hs <-  hfutils::as_ogr('/Users/mikejohnson/hydrofabric/v3.0/reference_fabric.gpkg', 
+  hs <-  hfutils::as_ogr(gpkg, 
                          'flowpaths')  |> 
   filter(vpuid == "01") |> 
   st_as_sf() |> 
-  add_hydroseq()
+  get_hydroseq()
 })
 
-head(hs$hydroseq)
+head(hs)
 ```
 
 ### Questions?

README.md

@@ -28,14 +28,6 @@ remotes::install_github("lynker-spatial/hfutils")
 ``` r
 library(hfutils)
 library(dplyr)
-#> 
-#> Attaching package: 'dplyr'
-#> The following objects are masked from 'package:stats':
-#> 
-#>     filter, lag
-#> The following objects are masked from 'package:base':
-#> 
-#>     intersect, setdiff, setequal, union
 ```
 
 ## Basic Use
@@ -45,7 +37,8 @@ library(dplyr)
 #### Basic connection: Dataset
 
 ``` r
-hfutils::as_ogr('/Users/mikejohnson/hydrofabric/v3.0/reference_fabric.gpkg')
+gpkg <- '/Users/mikejohnson/hydrofabric/v3.0/reference_fabric.gpkg'
+hfutils::as_ogr(gpkg)
 #> [1] "divides"        "flowpaths"      "hydrolocations" "pois"          
 #> [5] "network"
 #> <OGRSQLConnection>
@@ -56,7 +49,7 @@ hfutils::as_ogr('/Users/mikejohnson/hydrofabric/v3.0/reference_fabric.gpkg')
 #### Basic connection: Layer
 
 ``` r
-hfutils::as_ogr('/Users/mikejohnson/hydrofabric/v3.0/reference_fabric.gpkg', "divides") 
+hfutils::as_ogr(gpkg, "divides") 
 #> # Source:   table<"divides"> [?? x 6]
 #> # Database: OGRSQLConnection
 #>    divide_id vpuid areasqkm has_flowpath flowpath_id                        geom
@@ -77,7 +70,7 @@ hfutils::as_ogr('/Users/mikejohnson/hydrofabric/v3.0/reference_fabric.gpkg', "di
 #### Lazy Eval
 
 ``` r
-hfutils::as_ogr('/Users/mikejohnson/hydrofabric/v3.0/reference_fabric.gpkg', "divides") |> 
+hfutils::as_ogr(gpkg, "divides") |> 
   select(divide_id, areasqkm) 
 #> # Source:   SQL [?? x 2]
 #> # Database: OGRSQLConnection
@@ -99,7 +92,7 @@ hfutils::as_ogr('/Users/mikejohnson/hydrofabric/v3.0/reference_fabric.gpkg', "di
 #### sf extraction
 
 ``` r
-hfutils::as_ogr('/Users/mikejohnson/hydrofabric/v3.0/reference_fabric.gpkg', "divides")  |> 
+hfutils::as_ogr(gpkg, "divides")  |> 
   filter(vpuid == "01") |> 
   st_as_sf()
 #> Simple feature collection with 67880 features and 5 fields
@@ -141,29 +134,29 @@ hfutils::as_ogr('/vsis3/lynker-spatial/hydrofabric/v2.2/conus/conus_nextgen.gpkg
 ``` r
 ## Accumulate Downstream
 system.time({
-  da <-  hfutils::as_ogr('/Users/mikejohnson/hydrofabric/v3.0/reference_fabric.gpkg', 
+  da <-  hfutils::as_ogr(gpkg, 
                          'flowpaths')  |> 
   filter(vpuid == "01") |> 
   st_as_sf() |> 
   accumulate_downstream(attr = "areasqkm")})
 #>    user  system elapsed 
-#>   0.836   0.506   1.368
+#>   0.821   0.464   1.285
 
 head(da)
 #> [1]  15.66720  11.12805   4.44600   6.52365   4.53420 335.51145
 
 ## Hydrosequence
 system.time({
-  hs <-  hfutils::as_ogr('/Users/mikejohnson/hydrofabric/v3.0/reference_fabric.gpkg', 
+  hs <-  hfutils::as_ogr(gpkg, 
                          'flowpaths')  |> 
   filter(vpuid == "01") |> 
   st_as_sf() |> 
-  add_hydroseq()
+  get_hydroseq()
 })
 #>    user  system elapsed 
-#>   1.004   0.462   1.468
+#>   1.008   0.460   1.470
 
-head(hs$hydroseq)
+head(hs)
 #> [1]   804 22722 22724 22723 22725 28137
 ```