https://github.com/mzeefilexy/shinyTour
experimental tour/walkthrough/help package for shiny app
https://github.com/mzeefilexy/shinyTour
Last synced: 4 months ago
JSON representation
experimental tour/walkthrough/help package for shiny app
- Host: GitHub
- URL: https://github.com/mzeefilexy/shinyTour
- Owner: mzeefilexy
- License: mit
- Created: 2017-03-08T00:16:03.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-01-11T17:13:30.000Z (almost 10 years ago)
- Last Synced: 2024-11-27T11:37:27.521Z (about 1 year ago)
- Language: JavaScript
- Size: 216 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - mzeefilexy/shinyTour - experimental tour/walkthrough/help package for shiny app (JavaScript)
README
# shinyTour
Create a guided tour of inputs and groups of a Shiny app.
Inside a defined group in `ui.r`, every input label will be registered in a database. These entries could be described in edition mode. You can write knitr chunk in edit mode, so, there is no limit on what can be displayed in the draggable help boxes.
*This is an experimental implementation, you can expect a lot of changes.*
# Installation
```{r}
library(devtools)
install_github('fxi/shinyTour')
```
# Usage in a Shiny app
### Init tour (server.r)
In the server part, the only thing to do is to set a path to a sqlite db (automatically created)
```{r}
library(shinyTour)
# tour settings.
tConf<-tourConfig$new("~/Desktop/tour.sqlite")
# tour manager..
tourMembersManager(input,session,tConf)
```
### UI elements (ui.r)
```{r}
# tour panel : to place in the beginning of a page
tourPanel(title="shinyTour")
# overlay
div(class="tour_overlay",style="display: none;")
# Group to describe
tourGroup(id="demo_main",title="Main page",...)
```
# Example
## Edit mode
In edit mode, you can change the text of the group or input to describe.
You can write knitr chunck and it will be rendered in display mode.
So, it could be a good idea to hide the edit checkbox if your application is published.
## Display mode
In display mode, let your users learn about visible elements from your applications.
```{r}
library(shinyTour)
server <- function(input, output,session) {
# tour settings
tConf<-tourConfig$new("~/Desktop/tour.sqlite")
# tour manage all action.
tourMembersManager(input,session,tConf)
output$distPlot <- renderPlot({
hist(rnorm(input$obs), col = 'darkgray', border = 'white')
})
}
ui <- fluidPage(
tourPanel(title="shinyTour"),
div(class="tour_overlay",style="display: none;"),
tourGroup(id="demo_app","Your application",
sidebarLayout(
tourGroup(id="demo_side_bar",title="Your side bar",
sidebarPanel(
tourBtnTogglePanel('Start tour'),
checkboxInput('tour_panel_edit_mode','Edit mode'),
sliderInput("obs", "Number of observations:", min = 10, max = 500, value = 100)
)
),
mainPanel(plotOutput("distPlot"))
))
)
shinyApp(ui = ui, server = server)
```