From 35cba651196df4061b67cfeebccb8b1f3bb844cf Mon Sep 17 00:00:00 2001
From: CJ Yetman <cyetman@rmi.org>
Date: Mon, 25 Dec 2023 14:06:26 +0100
Subject: [PATCH] [sankey] document and export `sankey_explorer()`

---
 NAMESPACE              |  1 +
 R/sankey_explorer.R    | 11 +++++++++++
 man/sankey_explorer.Rd | 14 ++++++++++++++
 3 files changed, 26 insertions(+)
 create mode 100644 man/sankey_explorer.Rd

diff --git a/NAMESPACE b/NAMESPACE
index 146c468..fc02e3f 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -24,6 +24,7 @@ export(as_force_data)
 export(as_sankey_data)
 export(as_tree_data)
 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
index b7f85bd..856ed7e 100644
--- 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
new file mode 100644
index 0000000..12be3f0
--- /dev/null
+++ b/man/sankey_explorer.Rd
@@ -0,0 +1,14 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/sankey_explorer.R
+\name{sankey_explorer}
+\alias{sankey_explorer}
+\title{Interactive \code{sankey_network} options explorer}
+\usage{
+sankey_explorer(data)
+}
+\arguments{
+\item{data}{a network description in one of numerous forms (see details)}
+}
+\description{
+An interactive shiny widget to explore the \code{sankey_network} options.
+}