shinylogs

Logs for Shiny apps

https://github.com/dreamrs/shinylogs

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (18.1%) to scientific vocabulary

Keywords

logs r shiny shinyapps

Keywords from Contributors

interactive distance genomics book observability autograding hacking shellcodes archival network-simulation
Last synced: 6 months ago · JSON representation

Repository

Logs for Shiny apps

Basic Info
Statistics
  • Stars: 100
  • Watchers: 2
  • Forks: 13
  • Open Issues: 7
  • Releases: 5
Topics
logs r shiny shinyapps
Created about 7 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# shinylogs

> Logging tool for Shiny applications: record inputs or outputs changes, and infos about user's session. All recording is done client-side to not slow down the application and occupy the server.


[![version](https://www.r-pkg.org/badges/version/shinylogs)](https://CRAN.R-project.org/package=shinylogs)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![Project Status: Active The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Codecov test coverage](https://codecov.io/gh/dreamRs/shinylogs/branch/master/graph/badge.svg)](https://app.codecov.io/gh/dreamRs/shinylogs?branch=master)
[![R-CMD-check](https://github.com/dreamRs/shinylogs/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/dreamRs/shinylogs/actions/workflows/R-CMD-check.yaml)




## Installation

You can install the released version of shinylogs from [CRAN](https://CRAN.R-project.org/package=shinylogs) with:

```r
install.packages("shinylogs")
```

And the development version from [GitHub](https://github.com/dreamRs/shinylogs) with:

```r
# install.packages("remotes")
remotes::install_github("dreamRs/shinylogs")
```


## Usage

Call the main function `track_usage` in server part of application, and specify where to write logs:

```{r example, eval=FALSE}
library(shinylogs)

track_usage(storage_mode = store_json(path = "logs/"))
```

The function will record : 

* *inputs* : each time an input change, name, timestamp and value will be saved
* *errors* : errors propagated through outputs
* *outputs* : each time an output is re-generated
* *session* : informations about user's browser and the application

See the vignette for more details (` ?vignette("shinylogs")`) or the [online version](https://dreamrs.github.io/shinylogs/articles/shinylogs.html).


## Examples

Some example of what is recorded with logs from applications available on our Shiny-Server: http://shinyapps.dreamrs.fr/


Number of connections per applications:

```{r, echo=FALSE}
knitr::include_graphics("man/figures/connections-apps.png")
```


Number of connections over time :

```{r, echo=FALSE}
knitr::include_graphics("man/figures/connections-day.png")
```


Which tabs (from sidebar in {shinydashboard}) in [shinyWidgets](https://github.com/dreamRs/shinyWidgets) gallery are the most seen : 

```{r, echo=FALSE}
knitr::include_graphics("man/figures/shinyWidgets-tabs.png")
```


User-agent is recorded per connection and can be parsed with [uaparserjs](https://github.com/hrbrmstr/uaparserjs) :
(unique users are not registered as we use the open source version of shiny-server)

```{r, echo=FALSE}
knitr::include_graphics("man/figures/ua-family.png")
knitr::include_graphics("man/figures/ua-os.png")
```


## Development

This package use [{packer}](https://github.com/JohnCoene/packer) to manage JavaScript assets, see packer's [documentation](https://packer.john-coene.com/#/) for more.

Install nodes modules with:

```r
packer::npm_install()
```

Modify `srcjs/exts/shinylogs.js`, then run:

```r
packer::bundle()
```

Re-install R package and try `track_usage()` function.

Owner

  • Name: dreamRs
  • Login: dreamRs
  • Kind: organization
  • Email: info@dreamrs.fr
  • Location: Paris, France

La datascience avec un grand R

GitHub Events

Total
  • Issues event: 1
  • Watch event: 4
  • Delete event: 2
  • Issue comment event: 3
  • Push event: 6
  • Pull request event: 6
  • Create event: 1
Last Year
  • Issues event: 1
  • Watch event: 4
  • Delete event: 2
  • Issue comment event: 3
  • Push event: 6
  • Pull request event: 6
  • Create event: 1

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 93
  • Total Committers: 6
  • Avg Commits per committer: 15.5
  • Development Distribution Score (DDS): 0.086
Past Year
  • Commits: 5
  • Committers: 3
  • Avg Commits per committer: 1.667
  • Development Distribution Score (DDS): 0.4
Top Committers
Name Email Commits
pvictor p****r@g****m 85
Paul Campbell p****1@g****m 3
dependabot[bot] 4****] 2
phgrosjean p****n@s****g 1
olivroy 5****y 1
Etienne e****z@d****r 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 21
  • Total pull requests: 9
  • Average time to close issues: 4 months
  • Average time to close pull requests: 6 months
  • Total issue authors: 18
  • Total pull request authors: 6
  • Average comments per issue: 2.48
  • Average comments per pull request: 0.78
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 3
Past Year
  • Issues: 2
  • Pull requests: 2
  • Average time to close issues: 3 months
  • Average time to close pull requests: 7 days
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.5
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
  • sammerk (2)
  • sckott (2)
  • williamlai2 (1)
  • cayetanaasencio (1)
  • tanho63 (1)
  • phgrosjean (1)
  • Cervus1983 (1)
  • zilch42 (1)
  • marcusyoung (1)
  • yogat3ch (1)
  • jrosen48 (1)
  • samuelmf1 (1)
  • tkranenburg (1)
  • sldzys (1)
  • jejoenje (1)
Pull Request Authors
  • dependabot[bot] (6)
  • PaulC91 (3)
  • olivroy (2)
  • etienne-s (1)
  • pvictor (1)
  • phgrosjean (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (6)

Packages

  • Total packages: 2
  • Total downloads:
    • cran 921 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 5
    (may contain duplicates)
  • Total versions: 8
  • Total maintainers: 1
cran.r-project.org: shinylogs

Record Everything that Happens in a 'Shiny' Application

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 5
  • Downloads: 921 Last month
Rankings
Stargazers count: 4.1%
Forks count: 5.8%
Downloads: 7.4%
Average: 11.7%
Dependent repos count: 13.2%
Dependent packages count: 27.9%
Maintainers (1)
Last synced: 6 months ago
conda-forge.org: r-shinylogs
  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Stargazers count: 31.6%
Dependent repos count: 34.0%
Average: 39.4%
Forks count: 40.9%
Dependent packages count: 51.2%
Last synced: 6 months ago

Dependencies

DESCRIPTION cran
  • anytime * imports
  • bit64 * imports
  • data.table * imports
  • digest * imports
  • htmltools * imports
  • jsonlite * imports
  • nanotime * imports
  • shiny >= 1.1.0 imports
  • DBI * suggests
  • RSQLite * suggests
  • covr * suggests
  • googledrive * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • testthat * suggests
package-lock.json npm
  • 124 dependencies
package.json npm
  • dayjs ^1.10.7 development
  • localforage ^1.10.0 development
  • localforage-getitems ^1.4.2 development
  • webpack ^5.64.1 development
  • webpack-cli ^4.9.1 development
  • webpack-merge ^5.8.0 development
.github/workflows/R-CMD-check.yaml actions
  • actions/cache v1 composite
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/setup-pandoc master composite
  • r-lib/actions/setup-r master composite
.github/workflows/pkgdown.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
  • r-lib/actions/setup-r-dependencies v1 composite