diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html new file mode 100644 index 0000000..723d083 --- /dev/null +++ b/docs/CONTRIBUTING.html @@ -0,0 +1,89 @@ + +NA • hydroloom + Skip to contents + + +
+
+
+

NA

+ Source: CONTRIBUTING.md +
+ +
+

Contributing:

+

First, thanks for considering a contribution! I hope to make this package a community created resource for us all to gain from and won’t be able to do that without your help!

+
  1. Contributions should be thoroughly tested with testthat.
    2. +
  2. Code style should attempt to follow the tidyverse style guide.
    3. +
  3. Please attempt to describe what you want to do prior to contributing by submitting an issue.
    4. +
  4. Please follow the typical github fork - pull-request workflow.
    5. +
  5. Make sure you use roxygen and run Check before contributing. More on this front as the package matures.
    6. +
  6. +hydroloom uses tidyselection and data masking. Please review the list of hydroloom global attribute in R/00_hydroloom.R before contributing. They are used as package variables in tidy selection broadly.
    7. +

Other notes: - consider running lintr prior to contributing. - consider running goodpractice::gp() on the package before contributing. - consider running devtools::spell_check() if you wrote documentation. - this package uses pkgdown. Running pkgdown::build_site() will refresh it.

+
+ +
+ + +
+ + + + + + + diff --git a/docs/articles/flow-table-fig.jpeg b/docs/articles/flow-table-fig.jpeg new file mode 100644 index 0000000..3ea39a5 Binary files /dev/null and b/docs/articles/flow-table-fig.jpeg differ diff --git a/docs/reference/add_topo_sort.html b/docs/reference/add_topo_sort.html new file mode 100644 index 0000000..a28a6ed --- /dev/null +++ b/docs/reference/add_topo_sort.html @@ -0,0 +1,116 @@ + +Add topo_sort — add_topo_sort • hydroloom + Skip to contents + + +
+
+
+

Add topo_sort

+ Source: R/sort_network.R +
add_topo_sort.Rd
+
+ +
+

calls sort_network without support for splitting the network +and adds a nrow:1 topo_sort attribute.

+
+ +
+

Usage

+ 
add_topo_sort(x, outlets = NULL)
+
+# S3 method for data.frame
+add_topo_sort(x, outlets = NULL)
+
+# S3 method for hy
+add_topo_sort(x, outlets = NULL)
+
+ +
+

Arguments

+
x
+

data.frame network compatible with hydroloom_names.

+ + +
outlets
+

same as id in x. if specified, only the network +emanating from these outlets will be considered and returned. +NOTE: If outlets does not include all outlets from a given +network containing diversions, a partial network may be returned.

+ +
+
+

Value

+ + +

data.frame containing a topo_sort attribute.

+
+ +
+ + +
+ + + + + + +