add shiny example to add_shiny roxygen

timelyportfolio · Aug 30, 2016 · 4f72b6e9c12d23ff24f40828747ccbdce9ce075b · 4f72b6e
1 parent d3239b4
commit 4f72b6e9c12d23ff24f40828747ccbdce9ce075b
Unified Split

Showing with 53 additions and 0 deletions.

+1 −0 R/shiny.R

+3 −0 inst/examples/example_shiny.R

+49 −0 man/add_shiny.Rd
diff --git a/R/shiny.R b/R/shiny.R
@@ -5,6 +5,7 @@
 #'
 #' @return \code{sunburst} htmlwidget
 #' @export
+#' @example ./inst/examples/example_shiny.R
 add_shiny <- function(sunburst = NULL){
   stopifnot(!is.null(sunburst),inherits(sunburst,"sunburst"))
 

diff --git a/inst/examples/example_shiny.R b/inst/examples/example_shiny.R
@@ -1,3 +1,5 @@
+\dontrun{
+
 library(shiny)
 library(sunburstR)
 
@@ -42,3 +44,4 @@ ui<-fluidPage(
 )
 
 shinyApp(ui = ui, server = server)
+}
diff --git a/man/add_shiny.Rd b/man/add_shiny.Rd