https://github.com/RinteRface/webR4Shiny

Setup webR compatible infrastructure in your Shiny package project
https://github.com/RinteRface/webR4Shiny

Last synced: 9 days ago
JSON representation

Setup webR compatible infrastructure in your Shiny package project

• Host: GitHub
• URL: https://github.com/RinteRface/webR4Shiny
• Owner: RinteRface
• License: other
• Created: 2023-07-21T09:17:51.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-24T13:30:26.000Z (over 1 year ago)
• Last Synced: 2024-12-04T05:22:36.712Z (9 days ago)
• Language: R
• Size: 85 KB
• Stars: 20
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - RinteRface/webR4Shiny - Setup webR compatible infrastructure in your Shiny package project (R)

README

        
# webR4Shiny

Setup webR compatible infrastructure in your Shiny package project. This package is based on George Stagg's work around `{webR}`, particularly

this [repository](https://github.com/georgestagg/shiny-standalone-webr-demo) for deploying Shiny apps on Netlify.

What does `{golem4Shiny}`? Essentially, it:

- Copies relevant part of the `{golem}` app (`R`, `inst`) into the folder of your choice, default being `./webR`.

- Tweaks some of the `{golem}` copied files. Importantly, this __does not impact__ the main app files, only the copy located in `./webR`.

- Adds a slightly modified version of the JS technology to run webR and adapt with Shiny, originally [provided](https://github.com/georgestagg/shiny-standalone-webr-demo) by George Stagg.

- Adds a makefile to run the app locally and test.

An example app is deployed [here](https://golem-webr.rinterface.com/) at https://golem-webr.rinterface.com/.

## Installation

To get `{webR4Shiny}`:

```r

remotes::install_github("RinteRface/webR4Shiny")

```

Note that pre-compiled packages for WebAssembly are downloaded from `https://webr-cran.rinterface.com/`. This repository only contains

`{shiny}`, Shiny-related packages (httpuv, ...) and few RinteRface packages such as `{bs4Dash}`.

If you miss your favorite package, raise an issue [here](https://github.com/RinteRface/rinterface-webr-repo/issues). It is also

very possible that some package will not be available here for technical reasons.

## Workflow

`{webR4Shiny}` is designed to work for `{golem}` powered Shiny apps.

Under the project root, run:

```r

init_shiny_webr()

```

This installs all files needed to have a webR compatible Shiny app by default

under `./webr`.

Each time you change the code within your package (R, inst, ...), you have to run:

```r

update_shiny_webr("")

```

`` being either the default location, `./webR` or any valid

alternative of your choice.

Finally, to cleanup the webR installation run:

```r

remove_shiny_webr("")

```