Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wch/componenttemplate
Template for Shiny components
https://github.com/wch/componenttemplate
Last synced: about 1 month ago
JSON representation
Template for Shiny components
- Host: GitHub
- URL: https://github.com/wch/componenttemplate
- Owner: wch
- Created: 2023-05-25T15:52:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-23T14:49:39.000Z (over 1 year ago)
- Last Synced: 2024-10-10T18:21:15.784Z (2 months ago)
- Language: TypeScript
- Size: 106 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - wch/componenttemplate - Template for Shiny components (TypeScript)
README
Shiny component template
========================
This repository contains a simple template of a Shiny component for both R and Python.
The folders are organized as follows:
- `r`: R package
- `py`: Python package
- `js`: TypeScript code for the component
## Using the component
### R
Install the R package:
```R
remotes::install_github("wch/componenttemplate/r")
```
After installing, you can run the demo app. Either copy and paste the [example app](r/inst/examples/number/app.R) into your R console, or run:
```R
shiny::runApp(system.file("examples/number", package = "componenttemplate"))
```
### Python
To install the Python package:
```bash
pip uninstall -y componenttemplate
pip install "componenttemplate@git+https://github.com/wch/componenttemplate.git#subdirectory=py"
```
After installing, you can run the demo app. Save the [example app](py/examples/number/app.py) to a file named app.py, and run it:
```bash
shiny run app.py --port 8000 --launch-browser
```
If you have cloned the repository, you run the example app (without needing to create a new copy of the file):
```bash
shiny run py/examples/number/app.py --port 8000 --launch-browser
```
## Developing the component
To do development on the component, first clone this repository.
### R
You can use devtools to install the R package from the sources on disk. First start R in the `r/` directory, then run:
```R
devtools::install(".")
```
Or you can load the package from disk without installing. It will stay loaded for the duration of the R session.
```R
devtools::load_all(".")
```
### Python
To install the Python package in development mode:
```bash
# Create a virtual environment - recommended but not required
python -m venv venv
. venv/bin/activate
cd py
pip install -e .[dev]
```
### TypeScript
The component is written in TypeScript. To set up the build environment, install the dependencies:
```bash
cd js
npm i
```
To build the component:
```bash
npm run build
```