Shiny-Calorie: A context-aware application for indirect calorimetry data analysis and visualization using R
Documentation available through Github Pages: https://stephanmg.github.io/calorimetry
The app is available on the following web sites:
Please refer also to the supplementary material from Shiny-Calorie preprint [1].
Tutorial videos are available on YouTube: Tutorials.
One can use the Electron wrapper of the app which uses docker inside the Electron app: https://github.com/stephanmg/shiny-electron-wrapper
Releases are uploaded to Sciebo automatically here: https://uni-bonn.sciebo.de/s/0qDhG2Bu1VNkRli/
There you can download the nightly builds for Windows, OSX or Linux. Builds are automatically generated and artifacts deployed trough the build
Github workflow.
One can use the Shiny/R metadata converter app: https://github.com/stephanmg/metadata-converter The metadata converter will generate a truncated metadata sheet compatible for reading into Shiny-Calorie.
Alternatively you can fill out the standardized metadata sheet [2] yourself in Excel or fall back to relying on the metadata header of raw data sets.
- Pull Shiny-Calorie image from remote
docker pull stephanmg/Shiny-Calorie
- Start container
docker run --name Shiny-Calorie -it -p 1338:1338 stephanmg/Shiny-Calorie
- Open browser and navigate to: http://localhost:1338/
Note that you can also build your own container from the Dockerfile
provided with either docker
or podman
.
The Shiny-Calorie application is also hosted on http://shinyapps.io/stephanmg/Shiny-Calorie and deployed to our local infrastructure on http://shinys.iaas.uni-bonn.de/Shiny-Calorie
Note that on the Uni Bonn infrastructure, a small Kubernetes cluster is used for efficient multi-user usage, upscaling and load balancing.
- Clone this repository
- Install dependencies with
Rscript -e "library(renv); renv::restore()"
from the current working directory - Run
Rscript startapp.R
from base directory (inside this respository) - Optionally if you wish to use load balancing, use the shell script
start_app_instances.sh
which will run (specified by the user) a variable number of app instances in parallel.
An example Nginx configuration for load balancing is provided in nginx_config.txt
for administrators.
Note for developers: After building documentation a folder R
will be created in the root directory. Manually
delete this folder and do not add for tracking with Git, nor deploy, as this interferes with the Shiny app.
We need to fake a proper R package structure in order to use the roxygenise
functions, but do not need the
structure after docs have been generated.
- [1] Grein et al., Shiny-Calorie: A context-aware application for indirect calorimetry data analysis and visualization using R, https://doi.org/10.1101/2025.04.24.648116
- [2] Seep et al., From Planning Stage Towards FAIR Data: A Practical Metadatasheet For Biomedical Scientists, https://doi.org/10.1038/s41597-024-03349-2
The Shiny-Calorie image was created with the assistance of the AI tool DALL-E 2.