Crandore Hub

epiworldRShiny

A 'shiny' Wrapper of the R Package 'epiworldR'

R 'shiny' web apps for epidemiological Agent-Based Models. It provides a user-friendly interface to the Agent-Based Modeling (ABM) R package 'epiworldR' (Meyer et al., 2023) <DOI:10.21105/joss.05781>. Some of the main features of the package include the Susceptible-Infected-Susceptible (SIS), Susceptible-Infected-Recovered (SIR), and Susceptible-Exposed-Infected-Recovered (SEIR) models. 'epiworldRShiny' provides a web-based user interface for running various epidemiological ABMs, simulating interventions, and visualizing results interactively.

README

# Models in `epiworldRShiny`

This folder contains the pre-built models available in the app. 

## Model Format

Each model consists of two files:

- `shiny_<model_name>.R`: Contains the model's R code split into two functions:
    - `shiny_<model_name>()`: Runs the model and returns the results
    - `<model_name>_panel()`: Defines the model's UI control panel in the app
- `shiny_<model_name>.md`: Contains the model's documentation which is displayed in the app

**IMPORTANT NOTE:** All models must follow the above format or `epiworldRShiny` won't import them correctly. 

## Custom Models

`epiworldRShiny` allows users to add custom models to the app, either by adding to the `inst/models` folder or by passing a separate folder path to the `run_app()` function using the `custom_models_path` argument.

In either case, your models must follow the format described above.
Pay special attention to ensuring the `<model_name>` is used properly (e.g., the file name matches the function name).

Versions across snapshots

VersionRepositoryFileSize
0.2.3 rolling linux/jammy R-4.5 epiworldRShiny_0.2.3.tar.gz 276.6 KiB
0.2.3 rolling linux/noble R-4.5 epiworldRShiny_0.2.3.tar.gz 276.6 KiB
0.2.3 rolling source/ R- epiworldRShiny_0.2.3.tar.gz 225.8 KiB
0.2.3 latest linux/jammy R-4.5 epiworldRShiny_0.2.3.tar.gz 276.6 KiB
0.2.3 latest linux/noble R-4.5 epiworldRShiny_0.2.3.tar.gz 276.6 KiB
0.2.3 latest source/ R- epiworldRShiny_0.2.3.tar.gz 225.8 KiB
0.2.3 2026-04-26 source/ R- epiworldRShiny_0.2.3.tar.gz 225.8 KiB
0.2.3 2026-04-23 source/ R- epiworldRShiny_0.2.3.tar.gz 225.8 KiB
0.2.3 2026-04-09 windows/windows R-4.5 epiworldRShiny_0.2.3.zip 293.1 KiB
0.1-0 2025-04-20 source/ R- epiworldRShiny_0.1-0.tar.gz 19.7 KiB

Dependencies (latest)

Depends

Imports

Suggests