pkgdown

DOI-USGS · Aug 29, 2020 · 98ef93e · 98ef93e
1 parent ca38e56
commit 98ef93e
Show file tree

Hide file tree

Showing 76 changed files with 1,783 additions and 1,258 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: nhdplusTools
 Type: Package
 Title: NHDPlus Tools
-Version: 0.3.14
+Version: 0.3.15
 Authors@R: c(person(given = "David", 
                     family = "Blodgett", 
                     role = c("aut", "cre"), 

diff --git a/R/get_nldi.R b/R/get_nldi.R
@@ -49,7 +49,9 @@ discover_nldi_navigation <- function(nldi_feature, tier = "prod") {
 #' @inheritParams discover_nldi_sources
 #' @export
 #' @examples
-#' discover_nldi_characteristics()
+#' chars <- discover_nldi_characteristics()
+#' names(chars)
+#' head(chars$local, 10)
 discover_nldi_characteristics <- function(type="all", tier = "prod") {
 
   tc <- type_check(type)
@@ -227,7 +229,9 @@ get_nldi_feature <- function(nldi_feature, tier = "prod") {
 #' @inheritParams discover_nldi_characteristics
 #' @export
 #' @examples
-#' get_nldi_characteristics(list(featureSource = "nwissite", featureID = "USGS-05429700"))
+#' chars <- get_nldi_characteristics(list(featureSource = "nwissite", featureID = "USGS-05429700"))
+#' names(chars)
+#' head(chars$local, 10)
 get_nldi_characteristics <- function(nldi_feature, type="local", tier = "prod") {
 
   tc <- type_check(type)

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -37,6 +37,8 @@ reference:
       - '`discover_nhdplus_id`'
       - '`discover_nldi_sources`'
       - '`discover_nldi_navigation`'
+      - '`discover_nldi_characteristics`'
+      - '`get_nldi_characteristics`'
       - '`get_nldi_basin`'
       - '`get_nldi_feature`'
       - '`navigate_nldi`'

diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/DISCLAIMER.html b/docs/DISCLAIMER.html
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/articles/nhdplusTools.html b/docs/articles/nhdplusTools.html
diff --git a/docs/articles/nhdplusTools_files/figure-html/navigate_nldi-1.png b/docs/articles/nhdplusTools_files/figure-html/navigate_nldi-1.png
diff --git a/docs/articles/nhdplusTools_files/figure-html/nldi_nwissite-1.png b/docs/articles/nhdplusTools_files/figure-html/nldi_nwissite-1.png
diff --git a/docs/articles/nhdplusTools_files/figure-html/plot_fline_subset-1.png b/docs/articles/nhdplusTools_files/figure-html/plot_fline_subset-1.png
diff --git a/docs/articles/nhdplusTools_files/figure-html/plot_result-1.png b/docs/articles/nhdplusTools_files/figure-html/plot_result-1.png
diff --git a/docs/articles/nhdplusTools_files/figure-html/point-1.png b/docs/articles/nhdplusTools_files/figure-html/point-1.png
diff --git a/docs/articles/nhdplusTools_files/figure-html/staged_data-1.png b/docs/articles/nhdplusTools_files/figure-html/staged_data-1.png
diff --git a/docs/articles/nhdplusTools_files/figure-html/subset_nhdplus_download-1.png b/docs/articles/nhdplusTools_files/figure-html/subset_nhdplus_download-1.png
diff --git a/docs/articles/nhdplusTools_files/figure-html/tldr-1.png b/docs/articles/nhdplusTools_files/figure-html/tldr-1.png