documentation & clean up

Author: pvictor

DESCRIPTION

@@ -16,7 +16,9 @@ Authors@R:
       person(given = "Red",
              family = "Hat",
              role = "cph",
-             comment = "Modified version of Bootstrap Tree View"))
+             comment = "Modified version of Bootstrap Tree View"),
+      person(family = "DARES",
+             role = "fnd"))
 Description: A simple and elegant solution to displaying hierarchical tree structures in 'shiny' applications.
 License: GPL-3
 Encoding: UTF-8
@@ -25,4 +27,5 @@ Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.1.0
 Imports: 
     htmltools,
-    shiny
+    shiny,
+    jsonlite

NAMESPACE

@@ -2,5 +2,8 @@
 
 export(treeviewInput)
 importFrom(htmltools,htmlDependency)
+importFrom(htmltools,tags)
+importFrom(htmltools,validateCssUnit)
+importFrom(jsonlite,toJSON)
 importFrom(shiny,addResourcePath)
 importFrom(shiny,registerInputHandler)

R/input-treeview.R

@@ -1,15 +1,27 @@
 
-#' Title
+#' @title Tree view Input
 #'
-#' @param inputId
-#' @param label
-#' @param choices
-#' @param width
+#' @description Represent hierarchical tree structures to select a value in a nested list.
 #'
-#' @return
+#' @param inputId The \code{input} slot that will be used to access the value.
+#' @param label Display label for the control, or \code{NULL} for no label.
+#' @param choices A \code{list} to be used as choices.
+#' @param selected Default selected value.
+#' @param multiple Allow selection of multiple values.
+#' @param levels Sets the number of hierarchical levels deep the tree will be expanded to by default.
+#' @param borders Show or not borders around items.
+#' @param prevent_unselect When \code{multiple = TRUE}, prevent user to unselect a value.
+#' @param return_value Value returned server-side, default is the element name,
+#'  other possibility is to returned all the tree under the element selected.
+#' @param width The width of the input, e.g. \code{'400px'}, or \code{'100\%'}.
+#'
+#' @return A \code{character} value or a \code{list} depending on the \code{return_value} argument.
 #' @export
 #'
-#' @examples
+#' @importFrom htmltools tags validateCssUnit
+#' @importFrom jsonlite toJSON
+#'
+#' @example examples/basic.R
 treeviewInput <- function(inputId,
                           label = NULL,
                           choices,

examples/basic.R

@@ -1,5 +1,4 @@
-
-# Basic treeviewInput example ---------------------------------------------
+# Basic treeviewInput example --------------------------
 
 library(shiny)
 library(shinytreeview)
@@ -12,7 +11,7 @@ choices <- list(
       list(text = "Child 1.2")
     )
   ),
-  list(text = "Parent 2"), # , state = list(selected = TRUE)
+  list(text = "Parent 2"),
   list(text = "Parent 3"),
   list(
     text = "Parent 4",
@@ -26,7 +25,7 @@ choices <- list(
 
 
 ui <- fluidPage(
-  tags$h3("shinytreeview basic example"),
+  tags$h3("treeviewInput basic example"),
   treeviewInput(
     inputId = "tree", label = "Make a choice:",
     choices = choices, selected = "Parent 3",
@@ -41,6 +40,7 @@ server <- function(input, output, session) {
   })
 }
 
-shinyApp(ui, server)
+if (interactive())
+  shinyApp(ui, server)