[sankey] document and export sankey_explorer() (#24)

cjyetman · Dec 25, 2023 · 2916985 · 2916985
1 parent bd002d4
commit 2916985
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -25,6 +25,7 @@ export(as_sankey_data)
 export(as_tree_data)
 export(force_explorer)
 export(force_network)
+export(sankey_explorer)
 export(sankey_network)
 export(save_as_png)
 export(save_as_svg)

diff --git a/R/sankey_explorer.R b/R/sankey_explorer.R
@@ -1,3 +1,14 @@
+#' Interactive `sankey_network` options explorer
+#'
+#' @param data a network description in one of numerous forms (see details)
+#'
+#' @description
+#' An interactive shiny widget to explore the `sankey_network` options.
+#'
+#' @md
+#'
+#' @export
+
 sankey_explorer <- function(data) {
   if (!requireNamespace("shiny", quietly = TRUE)) {
     stop("You must have {shiny} installed to use `sankey_explorer()`")

diff --git a/man/sankey_explorer.Rd b/man/sankey_explorer.Rd