-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathREADME.Rmd
118 lines (83 loc) · 3.85 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
---
output: github_document
editor_options:
chunk_output_type: console
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{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/web/checks/check_results_shinyEventLogger.html) -->
[](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)