{"Package":"cicerone","Title":"Provide Tours of 'Shiny' Applications","Version":"1.0.4","Date":"2021-01-10","Authors@R":"\nc(\nperson(given = \"John\",\nfamily = \"Coene\",\nrole = c(\"aut\", \"cre\"),\nemail = \"jcoenep@gmail.com\",\ncomment = c(ORCID = \"0000-0002-6637-4107\")),\nperson(given = \"Etienne\",\nfamily = \"Bacher\",\nrole = \"ctb\",\nemail = \"etienne.bacher@protonmail.com\")\n)","Description":"Provide step by step guided tours of 'Shiny' applications.","License":"MIT + file LICENSE","Encoding":"UTF-8","LazyData":"true","Imports":"R6, shiny, assertthat","RoxygenNote":"7.1.1.9000","URL":"https://cicerone.john-coene.com/","BugReports":"https://github.com/JohnCoene/cicerone/issues","NeedsCompilation":"no","Packaged":"2021-01-10 22:10:19 UTC; jp","Author":"John Coene [aut, cre] (),\nEtienne Bacher [ctb]","Maintainer":"John Coene ","Repository":"CRAN","Date/Publication":"2021-01-10 23:00:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/cicerone_1.0.4.tar.gz","jsonAuthors":[{"name":"John Coene","email":"jcoenep@gmail.com","maintainer":true},{"name":"Etienne Bacher","email":"etienne.bacher@protonmail.com","maintainer":false}],"readme":"

\n\n# cicerone \n\n\n[![Travis build status](https://travis-ci.org/JohnCoene/cicerone.svg?branch=master)](https://travis-ci.org/JohnCoene/cicerone)\n[![CRAN status](https://www.r-pkg.org/badges/version/cicerone)](https://CRAN.R-project.org/package=cicerone)\n\n\nA 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.\n\n## Usage\n\nLet's create a very basic Shiny app to demonstrate: it takes a text input and on hitting a button simply prints it.\n\n```r\nlibrary(shiny)\n\nui <- fluidPage(\n textInput(\"text_inputId\", \"Enter some text\"),\n actionButton(\"submit_inputId\", \"Submit text\"),\n verbatimTextOutput(\"print\")\n)\n\nserver <- function(input, output){\n txt <- eventReactive(input$submit_inputId, {\n input$text_inputId\n })\n\n output$print <- renderPrint(txt())\n}\n\nshinyApp(ui, server)\n```\n\nNow we can create a guide to walk the user through the application: simply initialise a new guide from the `Cicerone` object then add `steps`.\n\n```r\nlibrary(cicerone)\n\nguide <- Cicerone$\n new()$ \n step(\n el = \"text_inputId\",\n title = \"Text Input\",\n description = \"This is where you enter the text you want to print.\"\n )$\n step(\n \"submit_inputId\",\n \"Send the Text\",\n \"Send the text to the server for printing\"\n )\n```\n\nThis 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.\n\n```r\nlibrary(shiny)\n\nui <- fluidPage(\n use_cicerone(), # include dependencies\n textInput(\"text_inputId\", \"Enter some text\"),\n actionButton(\"submit_inputId\", \"Submit text\"),\n verbatimTextOutput(\"print\")\n)\n\nserver <- function(input, output){\n\n # initialise then start the guide\n guide$init()$start()\n\n txt <- eventReactive(input$submit_inputId, {\n input$text_inputId\n })\n\n output$print <- renderPrint(txt())\n}\n\nshinyApp(ui, server)\n```\n\n![](./man/figures/demo.gif)\n\nAll options are detailed in the documentation of the object: `?Cicerone`. See the [site](https://cicerone.john-coene.com) for more information.\n\n## Installation\n\nYou can install the stable version from CRAN with:\n\n``` r\ninstall.packages(\"cicerone\")\n```\n\nYou can install the development version from Github with:\n\n``` r\n# install.packages(\"remotes\")\nremotes::install_github(\"JohnCoene/cicerone\")\n```\n","jobInfo":{"package":"cicerone","version":"1.0.4","parsingStatus":"success","parserVersion":1,"parsedAt":"2021-01-11T00:31:12+0000"}}

Description

Usage

Arguments

Examples