Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kalimu/shinyEventLogger
Logging Events in Complex Shiny Apps
https://github.com/kalimu/shinyEventLogger
events javascript-console logging mongodb r shiny
Last synced: about 1 month ago
JSON representation
Logging Events in Complex Shiny Apps
- Host: GitHub
- URL: https://github.com/kalimu/shinyEventLogger
- Owner: kalimu
- License: other
- Created: 2018-11-12T10:15:58.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-28T22:08:28.000Z (over 4 years ago)
- Last Synced: 2024-08-13T07:15:03.683Z (5 months ago)
- Topics: events, javascript-console, logging, mongodb, r, shiny
- Language: R
- Homepage: https://kalimu.github.io/shinyEventLogger/
- Size: 277 KB
- Stars: 27
- Watchers: 3
- Forks: 2
- Open Issues: 11
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - kalimu/shinyEventLogger - Logging Events in Complex Shiny Apps (R)
README
---
output: github_document
editor_options:
chunk_output_type: console
---
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/"
)
```
# shinyEventLogger
[](https://www.r-project.org/Licenses/MIT)
[](https://www.tidyverse.org/lifecycle/)
[](https://travis-ci.org/kalimu/shinyEventLogger)
[](https://cran.r-project.org/package=shinyEventLogger)
[](https://cran.r-project.org/package=shinyEventLogger)
[](https://CRAN.R-project.org/package=shinyEventLogger)
[](https://CRAN.R-project.org/package=shinyEventLogger)
[](http://hits.dwyl.io/kalimu/shinyEventLogger)
by [Kamil Wais](https://kalimu.github.io/)
> **Logging Events in Complex Shiny Apps**.
Logging framework dedicated for complex shiny apps.
Different types of events can be logged (character string,
value of a variable, multi-line output of a function,
result of a unit test, custom error, warning, or diagnostic message).
Each event can be logged with a list of parameters that are event-specific,
common for a group of events, or common for all app events.
Logging can be done simultaneously to R console,
browser JavaScript console, a file log, and a database (currently MongoDB).
Log data can be further analyzed with the help of process-mining techniques
from 'bupaR' package.
## Installation
### Installing stable version from CRAN
```{r, echo=TRUE, eval=FALSE, cache=FALSE}
install.packages("shinyEventLogger")
```
### Installing version in development from GitHub
```{r, echo=TRUE, eval=FALSE, cache=FALSE}
# install.packages('devtools')
devtools::install_github("kalimu/shinyEventLogger")
```
## Demo Apps
Simple app logging different events to R console,
browser JavaScript console and to a file.
```{r, echo=TRUE, eval=FALSE, cache=FALSE}
shinyEventLogger::run_demo()
```
Dashboard that allows for interactive analysis of events from demo app.
```{r, echo=TRUE, eval=FALSE, cache=FALSE}
shinyEventLogger::run_demo_dashboard()
```
## Hello World
```{r, echo=TRUE, eval=FALSE, cache=FALSE}
library(shiny)
library(shinyEventLogger)
set_logging()
shinyApp(
ui = fluidPage(log_init()),
server = function(input, output) {
set_logging_session()
log_event("Hello World")
}
)
```
Executing the code above you should see in the console something like this:
|#1|EVENT|Hello World|FIRED|
## Demo Shiny Apps
* [DemoApp](https://kalimu.shinyapps.io/demoapp/)
-- demo shiny app logging different types of events.
* [DashboardApp](https://kalimu.shinyapps.io/dashboardapp/)
-- demo dashboard showing examples how logged events from the `DemoApp`
can be analyzed
## Documentation
Package docs (`pkgdown`):
[https://kalimu.github.io/shinyEventLogger/index.html](https://kalimu.github.io/shinyEventLogger/index.html)
Project description (on homepage):
[https://kalimu.github.io/project/shinyeventlogger/](https://kalimu.github.io/project/shinyeventlogger/)
For other logging packages see:
[https://github.com/daroczig/logger](https://github.com/daroczig/logger)