Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.1%) to scientific vocabulary
Keywords from Contributors
Repository
Create Tours in Shiny Apps Using Shepherd.js.
Basic Info
- Host: GitHub
- Owner: etiennebacher
- License: other
- Language: R
- Default Branch: main
- Homepage: https://conductor.etiennebacher.com
- Size: 1.77 MB
Statistics
- Stars: 36
- Watchers: 2
- Forks: 1
- Open Issues: 5
- Releases: 2
Metadata Files
README.md
conductor
Create tours in Shiny apps using shepherd.js.
Installation
You can install the development version (recommended) of conductor from GitHub with:
``` r
install.packages("devtools")
devtools::install_github("etiennebacher/conductor") ```
You can also install the CRAN version, but the last bug corrections are not there yet:
r
install.packages("conductor")
How to use
If you already use cicerone, then you should be able to use conductor quite easily.
Create a conductor
First, create a Conductor with Conductor$new(). This can be done anywhere, not necessarily in the ui or server parts of the app. You can also add some options in $new(). To add steps in the tour, use $step(). Steps can be attached to specific elements with el, but if no el is specified then the popover will be displayed in the center of the screen.
```r
library(conductor)
conductor <- Conductor$ new()$ step( title = "Hello there", text = "This popover is displayed in the center of the screen." )$ step( el = "#test", title = "This is a button", text = "This button has no purpose. Its only goal is to serve as support for demo." ) ```
Call the conductor
Then, call useConductor() in the ui and call conductor$init()$start() anywhere in the server.
```r library(shiny)
ui <- fluidPage( useConductor(), actionButton("test", "Test") )
server <- function(input, output, session){ conductor$init()$start() }
shinyApp(ui, server) ```
Similar packages
This is not at all the first package to enable tours in Shiny applications. Similar packages are:
Acknowledgements
The structure of the package, the code and the docs of conductor are copied or largely inspired from cicerone, by John Coene.
How to contribute
This package uses John Coene's {packer}. If you want to contribute to the JavaScript files located in srcjs, you should run packer::npm_install(), do the modifications you want and then run:
r
packer::bundle()
devtools::load()
Please note that the conductor project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
Owner
- Name: Etienne Bacher
- Login: etiennebacher
- Kind: user
- Website: etiennebacher.com
- Repositories: 147
- Profile: https://github.com/etiennebacher
GitHub Events
Total
- Watch event: 1
- Delete event: 15
- Issue comment event: 15
- Push event: 17
- Pull request event: 31
- Create event: 13
Last Year
- Watch event: 1
- Delete event: 15
- Issue comment event: 15
- Push event: 17
- Pull request event: 31
- Create event: 13
Committers
Last synced: over 3 years ago
All Time
- Total Commits: 134
- Total Committers: 5
- Avg Commits per committer: 26.8
- Development Distribution Score (DDS): 0.328
Top Committers
| Name | Commits | |
|---|---|---|
| etiennebacher | e****r@p****m | 90 |
| etiennebacher | y****u@e****m | 19 |
| dependabot[bot] | 4****]@u****m | 15 |
| Etienne Bacher | 5****r@u****m | 8 |
| Etienne Bacher | e****e@l****l | 2 |
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 24
- Total pull requests: 81
- Average time to close issues: 18 days
- Average time to close pull requests: about 14 hours
- Total issue authors: 5
- Total pull request authors: 2
- Average comments per issue: 1.42
- Average comments per pull request: 1.28
- Merged pull requests: 71
- Bot issues: 0
- Bot pull requests: 77
Past Year
- Issues: 0
- Pull requests: 20
- Average time to close issues: N/A
- Average time to close pull requests: about 1 hour
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 1.0
- Merged pull requests: 15
- Bot issues: 0
- Bot pull requests: 20
Top Authors
Issue Authors
- etiennebacher (20)
- marcusyoung (1)
- k-maciejewski (1)
- nhward (1)
- ceilingt1le (1)
Pull Request Authors
- dependabot[bot] (105)
- etiennebacher (5)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- cran 188 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 2
- Total maintainers: 1
cran.r-project.org: conductor
Create Tours in 'Shiny' Apps Using 'Shepherd.js'
- Homepage: https://github.com/etiennebacher/conductor
- Documentation: http://cran.r-project.org/web/packages/conductor/conductor.pdf
- License: MIT + file LICENSE
-
Latest release: 0.1.1
published almost 4 years ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v2 composite
- r-lib/actions/check-r-package v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
- JamesIves/github-pages-deploy-action v4.4.1 composite
- actions/checkout v4 composite
- quarto-dev/quarto-actions/setup v2 composite
- actions/checkout v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
- R6 * imports
- htmltools * imports
- shiny * imports
- altdoc * suggests
- shinytest2 * suggests
- testthat * suggests
- 140 dependencies
- css-loader ^6.9.0 development
- style-loader ^3.3.4 development
- webpack ^5.89.0 development
- webpack-cli ^5.1.1 development
- webpack-merge ^5.10.0 development
- shepherd.js ^11.1.1