https://github.com/JohnCoene/cicerone

🏛️ Give tours of your Shiny apps
https://github.com/JohnCoene/cicerone

hacktoberfest r rstats shiny tour

Last synced: 28 days ago
JSON representation

🏛️ Give tours of your Shiny apps

• Host: GitHub
• URL: https://github.com/JohnCoene/cicerone
• Owner: JohnCoene
• License: other
• Created: 2019-11-21T13:05:47.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-25T01:40:33.000Z (8 months ago)
• Last Synced: 2024-10-15T00:51:46.516Z (about 2 months ago)
• Topics: hacktoberfest, r, rstats, shiny, tour
• Language: R
• Homepage: https://cicerone.john-coene.com
• Size: 13 MB
• Stars: 192
• Watchers: 4
• Forks: 7
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-shiny-extensions - cicerone - Create guided tours for Shiny apps using driver.js. (UI Components / Walkthrough / Tooltip / Help)
• jimsghstars - JohnCoene/cicerone - 🏛️ Give tours of your Shiny apps (R)

README

        


# cicerone 

[![Travis build status](https://travis-ci.org/JohnCoene/cicerone.svg?branch=master)](https://travis-ci.org/JohnCoene/cicerone)

[![CRAN status](https://www.r-pkg.org/badges/version/cicerone)](https://CRAN.R-project.org/package=cicerone)

A convenient API to create guided tours of Shiny applications using [driver.js](https://kamranahmed.info/driver.js/), visit the [website](https://cicerone.john-coene.com/) for more details.

## Usage

Let's create a very basic Shiny app to demonstrate: it takes a text input and on hitting a button simply prints it.

```r

library(shiny)

ui <- fluidPage(

  textInput("text_inputId", "Enter some text"),

  actionButton("submit_inputId", "Submit text"),

  verbatimTextOutput("print")

)

server <- function(input, output){

  txt <- eventReactive(input$submit_inputId, {

    input$text_inputId

  })

  output$print <- renderPrint(txt())

}

shinyApp(ui, server)

```

Now we can create a guide to walk the user through the application: simply initialise a new guide from the `Cicerone` object then add `steps`.

```r

library(cicerone)

guide <- Cicerone$

  new()$ 

  step(

    el = "text_inputId",

    title = "Text Input",

    description = "This is where you enter the text you want to print."

  )$

  step(

    "submit_inputId",

    "Send the Text",

    "Send the text to the server for printing"

  )

```

This is our guide created, we can now include it the Shiny app we created earlier and start the guide. Note to that you need to include `use_cicerone` in your UI.

```r

library(shiny)

ui <- fluidPage(

  use_cicerone(), # include dependencies

  textInput("text_inputId", "Enter some text"),

  actionButton("submit_inputId", "Submit text"),

  verbatimTextOutput("print")

)

server <- function(input, output){

  # initialise then start the guide

  guide$init()$start()

  txt <- eventReactive(input$submit_inputId, {

    input$text_inputId

  })

  output$print <- renderPrint(txt())

}

shinyApp(ui, server)

```

![](./man/figures/demo.gif)

All options are detailed in the documentation of the object: `?Cicerone`. See the [site](https://cicerone.john-coene.com) for more information.

## Installation

You can install the stable version from CRAN with:

``` r

install.packages("cicerone")

```

You can install the development version from Github with:

``` r

# install.packages("remotes")

remotes::install_github("JohnCoene/cicerone")

```