https://github.com/Ewan-Keith/shinyShortcut
Create executable files to run shiny apps directly in your browser
https://github.com/Ewan-Keith/shinyShortcut
r r-shiny shortcut
Last synced: 4 months ago
JSON representation
Create executable files to run shiny apps directly in your browser
- Host: GitHub
- URL: https://github.com/Ewan-Keith/shinyShortcut
- Owner: Ewan-Keith
- License: gpl-3.0
- Created: 2017-03-12T21:46:55.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-12-31T15:41:45.000Z (over 6 years ago)
- Last Synced: 2024-08-13T07:15:40.094Z (8 months ago)
- Topics: r, r-shiny, shortcut
- Language: R
- Homepage:
- Size: 39.1 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - Ewan-Keith/shinyShortcut - Create executable files to run shiny apps directly in your browser (R)
README
---
output: github_document
---
shinyShortcut
============================================
[](https://travis-ci.org/Ewan-Keith/shinyShortcut)
[](https://ci.appveyor.com/project/Ewan-Keith/shinyShortcut)
[](https://codecov.io/gh/Ewan-Keith/shinyShortcut) [](https://cran.r-project.org/package=shinyShortcut)
Overview
--------
This package allows users to create a shortcut for their shiny app that, when run, will launch the app directly in the user's default browser. No need to navigate to the correct working directory in R (or even to open R at all!). Simply run the shortcut and the app will fire up. Works for both windows and linux based systems.
Inspired by [this blog post](http://www.mango-solutions.com/wp/2017/03/shiny-based-tablet-or-desktop-app/) by Mark Sellors at Mango Solutions.
Installation
------------
```{r, eval=FALSE}
# Install from CRAN
install.packages("shinyShortcut")
# Install from Github
# install.packages("devtools")
devtools::install_github("ewan-keith/shinyShortcut")
```
Usage
-----
The package loads just a single function, also named `shinyShortcut()`. It takes three arguments:
* `shinyDirectory`: The home directory of your shiny app (that contains your `server.r`, `ui.r`, or `app.r` files).
* `OS`: The operating system for the app to be ran on, must be `"windows"` or `"unix"`.
* `gitIgnore`: Whether to update the `.gitignore` file to prevent the shortcut files being tracked by git.
The function writes an exectuable script (.vbs on windows and .desktop on unix) in to the app's home directory. Shortcuts to this file can then be created elsewhere on the user's system. The function also creates a new directory `/.shiny_run` into which is written the raw batch or bash script (Windows and unix respectively) that runs the shiny app.
When the `shinyDirectory` is the current working directory then the default arguments are sufficient.
```{r, eval = FALSE}
library(shinyShortcut)
shinyShortcut()
```