{"id":16971492,"url":"https://github.com/johncoene/cicerone","last_synced_at":"2025-04-10T02:27:12.532Z","repository":{"id":40853289,"uuid":"223175985","full_name":"JohnCoene/cicerone","owner":"JohnCoene","description":"🏛️ Give tours of your Shiny apps","archived":false,"fork":false,"pushed_at":"2024-04-25T01:40:33.000Z","size":13679,"stargazers_count":192,"open_issues_count":29,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-15T00:51:46.516Z","etag":null,"topics":["hacktoberfest","r","rstats","shiny","tour"],"latest_commit_sha":null,"homepage":"https://cicerone.john-coene.com","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JohnCoene.png","metadata":{"files":{"readme":"README.md","changelog":"NEWS.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-21T13:05:47.000Z","updated_at":"2024-10-12T08:31:28.000Z","dependencies_parsed_at":"2024-10-26T01:04:38.474Z","dependency_job_id":null,"html_url":"https://github.com/JohnCoene/cicerone","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohnCoene%2Fcicerone","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohnCoene%2Fcicerone/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohnCoene%2Fcicerone/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JohnCoene%2Fcicerone/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JohnCoene","download_url":"https://codeload.github.com/JohnCoene/cicerone/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248143811,"owners_count":21054834,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","r","rstats","shiny","tour"],"created_at":"2024-10-14T00:51:59.993Z","updated_at":"2025-04-10T02:27:12.509Z","avatar_url":"https://github.com/JohnCoene.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"./man/figures/logo.png\" align = \"right\" height=250/\u003e\n\n# cicerone \n\n\u003c!-- badges: start --\u003e\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\u003c!-- badges: end --\u003e\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 \u003c- fluidPage(\n  textInput(\"text_inputId\", \"Enter some text\"),\n  actionButton(\"submit_inputId\", \"Submit text\"),\n  verbatimTextOutput(\"print\")\n)\n\nserver \u003c- function(input, output){\n  txt \u003c- eventReactive(input$submit_inputId, {\n    input$text_inputId\n  })\n\n  output$print \u003c- 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 \u003c- 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 \u003c- 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 \u003c- function(input, output){\n\n  # initialise then start the guide\n  guide$init()$start()\n\n  txt \u003c- eventReactive(input$submit_inputId, {\n    input$text_inputId\n  })\n\n  output$print \u003c- 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\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohncoene%2Fcicerone","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohncoene%2Fcicerone","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohncoene%2Fcicerone/lists"}