https://github.com/appsilon/shiny.tictoc
Measuring shiny performance in the browser.
https://github.com/appsilon/shiny.tictoc
Last synced: 2 months ago
JSON representation
Measuring shiny performance in the browser.
- Host: GitHub
- URL: https://github.com/appsilon/shiny.tictoc
- Owner: Appsilon
- Created: 2023-12-18T11:18:10.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-08T12:29:11.000Z (about 2 years ago)
- Last Synced: 2025-08-24T07:37:19.262Z (5 months ago)
- Language: JavaScript
- Size: 21.5 KB
- Stars: 26
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
Awesome Lists containing this project
README
# shiny.tictoc
`{shiny.tictoc}` allows you to measure:
1. How much time your Shiny app is spending doing server side calculations
2. How long does it take to recalculate outputs in your app
and export results in form of a CSV file. All that without the need of installing additional software and setting up testing scenarios - everything happens in the browser.
## Getting Started
To start using `shiny.tictoc` in your app, just add the following line somewhere in your UI definition (see example [here](./examples/app.R)):
```r
tags$script(
src = "https://cdn.jsdelivr.net/gh/Appsilon/shiny.tictoc@v0.2.0/shiny-tic-toc.min.js"
)
```
Next, open your app and interact with it.
To access the benchmarks [open the browser devtools](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/Tools_and_setup/What_are_browser_developer_tools) (Windows: F12, macOS ⌘ + ⌥ + I) and in the console run:
```js
// Print out all measurements
showAllMeasurements()
// To download all measurements as a CSV file
exportMeasurements()
// To print out summarised measurements (slowest rendering output, slowest server computation)
showSummarisedMeasurements()
// To export an html file that visualizes measurements on a timeline
await exportHtmlReport()
```