first pass documentation

NAMESPACE

@@ -1,5 +1,8 @@
 # Generated by roxygen2: do not edit by hand
 
+export(bipartiteNetwork)
+export(bipartiteNetworkOutput)
+export(renderBipartiteNetwork)
 import(dplyr)
 import(ggplot2)
 import(htmlwidgets)
@@ -8,6 +11,8 @@ importFrom(DT,DTOutput)
 importFrom(DT,renderDT)
 importFrom(bslib,bs_theme)
 importFrom(r2d3,html_dependencies_d3)
+importFrom(shiny,export)
+importFrom(shiny,shinyApp)
 importFrom(shinyjs,useShinyjs)
 importFrom(stats,rnorm)
 importFrom(utils,read.table)

R/app.R

@@ -1,3 +1,9 @@
+#' corGraph Shiny App
+#' 
+#' Launches the corGraph Shiny App 
+#'
+#' @importFrom shiny shinyApp
+#' export
 corGraph <- function(...) {
-  shinyApp(ui, server, ...)
+  shiny::shinyApp(ui, server, ...)
 }

R/bipartiteNetworkWidget.R

@@ -2,9 +2,18 @@ library(htmlwidgets)
 library(dplyr)
 library(r2d3)
 
+#' bipartiteNetwork
+#' 
+#' Create a bipartiteNetwork widget
+#' 
+#' @param data a data frame with source, target, and value columns
+#' @param width the width of the widget
+#' @param height the height of the widget
+#' @param elementId the ID of the widget
 #' @import htmlwidgets
 #' @importFrom r2d3 html_dependencies_d3
 #' @import dplyr
+#' @export
 bipartiteNetwork <- function(data, width = NULL, height = NULL, elementId = NULL) {
   if (!inherits(data, "data.frame") || !all(c("source", "target", "value") %in% names(data))) {
     stop("Data must be a data frame with source, target, and value columns.")
@@ -26,10 +35,26 @@ bipartiteNetwork <- function(data, width = NULL, height = NULL, elementId = NULL
   )
 }
 
+#' Shiny bindings for bipartiteNetwork
+#' 
+#' Output function for using bipartiteNetwork within Shiny apps
+#' 
+#' @param outputId output variable to read from
+#' @param width,height Must be a valid CSS unit (like \code{'100\%'}, '400px', or 'auto')
+#' @export
 bipartiteNetworkOutput <- function(outputId, width = '100%', height = '400px'){
   htmlwidgets::shinyWidgetOutput(outputId, 'bipartitenetwork', width, height, package = 'correlationMatrixAsNetwork')
 }
 
+#' Shiny bindings for bipartiteNetwork
+#' 
+#' Render function for using bipartiteNetwork within Shiny apps
+#' 
+#' @param expr an expression that generates bipartiteNetwork
+#' @param env the environment in which to evaluate \code{expr}
+#' @param quoted Is \code{expr} a quoted expression (with \code{quote()})? This
+#'   is useful if you want to save an expression in a variable
+#' @export
 renderBipartiteNetwork <- function(expr, env = parent.frame(), quoted = FALSE) {
   if (!quoted) { expr <- substitute(expr) } 
   htmlwidgets::shinyRenderWidget(expr, bipartiteNetworkOutput, env, quoted = TRUE)