DataRepExp

DataRepExp: a R shiny Application that makes Data FAIR for Data Repositories - Published in JOSS (2024)

https://github.com/rorychenxy/datarepexp_public

Science Score: 93.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
    Found 3 DOI reference(s) in README and JOSS metadata
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 6 months ago · JSON representation

Repository

A shiny app that was developed to improve the FAIR of research data hosted on data repository.

Basic Info
  • Host: GitHub
  • Owner: RoryChenXY
  • License: mit
  • Language: R
  • Default Branch: main
  • Size: 18.1 MB
Statistics
  • Stars: 5
  • Watchers: 1
  • Forks: 1
  • Open Issues: 1
  • Releases: 2
Created about 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme License

README.md

Welcome to DataRepExp

The Data Repository Explorer, DataRepExp, is an open-source R Shiny application developed to improve the findability, accessibility, interoperability, and reusability (FAIR) of research data held in a data repository.

The application displays standardised metadata across multiple studies including data availability by categories (such as demographics, medical history, imaging data and genomic data) to allow high-level comparison. It enables users to explore and run preliminary analysis from participants that match certain criteria. In addition, it provides features to export reports and aggregated results for data access application purposes.

This demo application was created using simulated health-related data for demonstration purposes. It can be modified and utilized by other data repositories by adopting the discipline-specific metadata schema and common variables.

To simplify the deployment process of the shiny application, the source code was converted to an R package under the {golem} framework.

Deployment

To run the demo app locally, please use the following syntax:

```

devtools::installgithub("RoryChenXY/DataRepExppublic", subdir="datarepexp")

library(datarepexp)

datarepexp::repexp_app()

```

How to navigate the application

The side menu allows you to switch between tabs, and the menu icon on the top allows you to collapse and expand the menu.

Side Menu

The Metadata Tab includes metadata of studies, listed in two tables, and provides a high-level comparison. All tables allow you to search, sort, and filter, and the "CLEAR" button resets the table to its original status.

Metadata Tab

The Filters Tab includes filters at both the study level and participant level, so that you can adjust and apply filters to identify studies and participants that match the selected criteria. The "Clear" buttons reset the filters. The Filters Tab also allows you to review and download the filters you have applied, and the study/studies you have identified in the Filters Report page.

Filters study Filters report

The Visualisation Tab generates results based on the filters you have applied. All plots are organised into sub-tabs by domain.

Visualisation Tab

The Preliminary Analysis Tab generates results based on the filters you have applied. The variable options are separated by categorical and quantitative variables.

Preliminary Analysis Tab

All plots can be downloaded. They have interactive features such as zoom, select, adjust axis, hover for information, reset, etc.

Deployment Notes

To make modifications to the applications for your purposes, R and Shiny programming skills are required, as well as an understanding of Shiny modules and golem.

  1. The application uses both study-level metadata, and particicipant-level data, and a data dictionary. Detail Notes and scripts used to generate data are included in the repository: Data Preparation Notes.
  2. DataRepExp was built in Shiny modules. Modularity makes the app easy to test, maintain, and deploy. The features can be easily further expanded with loose coupling module design.
  3. The Data Repository Explorer, DataRepExp, is hosted through easy-to-use shinyapps.io, while the DPAU version is hosted on AWS environment using Shiny Server for high availability, scalability, security, and compliance. The detailed deployment instructions can be found here
  4. Considering some repositories may hold highly sensitive data, or individual-level data may not be not available, a metadata-only version may be more appropriate.

Acknowledgements

This application was inspired by the visualization tool developed by Dementias Platform UK(DPUK) using PowerBI, then developed for the Dementias Platform Australia (DPAU) in R-Shiny. We acknowledge the generous sharing of best practices and knowledge from DPUK.

Funding

This work is supported by grants from the National Institute on Aging/ National Institute of Health (NIA/NIH) [1RF1AG057531-01] and the Medical Research Council [MRC/T0333771].

Availability and Community Guidelines

The application and associated documentation are open source (MIT License), but we ask that you kindly acknowledge our work. Users and contributors are welcome to contribute, request features, and report bugs through the GitHub repository. Contributing Guidelines

Owner

  • Name: Rory
  • Login: RoryChenXY
  • Kind: user
  • Location: Sydney, AU
  • Company: UNSW

JOSS Publication

DataRepExp: a R shiny Application that makes Data FAIR for Data Repositories
Published
September 30, 2024
Volume 9, Issue 101, Page 6693
Authors
Rory Chen ORCID
Centre for Healthy Brain Ageing, Discipline of Psychiatry & Mental Health, School of Clinical Medicine, University of New South Wales, Sydney, Australia
Vibeke S. Catts ORCID
Centre for Healthy Brain Ageing, Discipline of Psychiatry & Mental Health, School of Clinical Medicine, University of New South Wales, Sydney, Australia
Ashleigh Vella ORCID
Centre for Healthy Brain Ageing, Discipline of Psychiatry & Mental Health, School of Clinical Medicine, University of New South Wales, Sydney, Australia
Juan Carlo San Jose ORCID
Research Technology Services, University of New South Wales, Sydney, Australia
Sarah Bauermeister ORCID
Dementias Platform UK, Oxford, United Kingdom, Department of Psychiatry, University of Oxford, Oxford, United Kingdom
Joshua Bauermeister ORCID
Dementias Platform UK, Oxford, United Kingdom, Department of Psychiatry, University of Oxford, Oxford, United Kingdom
Emma Squires ORCID
Dementias Platform UK, Oxford, United Kingdom, Population Data Science, Swansea University, Swansea, United Kingdom
Simon Thompson ORCID
Dementias Platform UK, Oxford, United Kingdom, Population Data Science, Swansea University, Swansea, United Kingdom
John Gallacher ORCID
Dementias Platform UK, Oxford, United Kingdom, Department of Psychiatry, University of Oxford, Oxford, United Kingdom
Perminder S. Sachdev ORCID
Centre for Healthy Brain Ageing, Discipline of Psychiatry & Mental Health, School of Clinical Medicine, University of New South Wales, Sydney, Australia
Editor
Chris Vernon ORCID
Tags
Shiny golem dashboard repository visualisation FAIR

GitHub Events

Total
  • Watch event: 1
  • Push event: 1
Last Year
  • Watch event: 1
  • Push event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 244
  • Total Committers: 1
  • Avg Commits per committer: 244.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 34
  • Committers: 1
  • Avg Commits per committer: 34.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
RoryXChen r****y@g****m 244

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 5
  • Total pull requests: 1
  • Average time to close issues: 3 months
  • Average time to close pull requests: N/A
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 2.6
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • elimillera (3)
  • pydemull (2)
Pull Request Authors
  • RoryChenXY (2)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/joss-pdf.yml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite
datarepexp/DESCRIPTION cran
  • R >= 4.4 depends
  • shiny >= 1.8.1.1 depends
  • DT >= 0.33 imports
  • RColorBrewer >= 1.1.3 imports
  • collapse >= 2.0.14 imports
  • config >= 0.3.2 imports
  • dplyr >= 1.1.4 imports
  • forcats >= 1.0.0 imports
  • ggplot2 >= 3.5.1 imports
  • golem >= 0.4.1 imports
  • grDevices >= 4.4.0 imports
  • magrittr >= 2.0.3 imports
  • plotly >= 4.10.4 imports
  • purrr >= 1.0.2 imports
  • rlang >= 1.1.4 imports
  • scales >= 1.3.0 imports
  • shinyWidgets >= 0.8.6 imports
  • shinydashboard >= 0.7.2 imports
  • shinyjs >= 2.1.0 imports
  • tidyr >= 1.3.1 imports
  • useful >= 1.2.6.1 imports
  • covr * suggests
  • covrpage * suggests
  • devtools * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • shinytest2 * suggests
  • testthat >= 3.2.1.1 suggests