Skip to content

IMCR-Hackathon/datapie

 
 

Repository files navigation

Travis-CI Build Status AppVeyor Build Status codecov.io

datapie

This package allows users to explore the suitibility of a data package for further inquiry via a R Shiny. Users identify data packages of interest by passing a DOI to a GUI interface and then browse summary reports and generate exploritory plots. The package also attempts to address some common shortcomings of data formats to aid suitability evaluation. Data is highly diverse and we provide no guarantee this will actually work for a given data package, but it's worth a shot!

Background

Data can be a valuable scientific resource. However the inherent existance of information is not sufficeint to valuable, data must also be Findable Accesible Interoperable Reusable.

This project assists researchers and other data users who wish to reuse existing data packages that are archived on DataOne member notes. We provide a R shiny application (built off of the framework provided by ggplotgui) that 1) downloads identified DOIs registared on DataOne member notes, 2) reads in the data into a light weight viewer, 3) provides summary statistics and basic graphics describing the data package, and 4) generates a more robust report describing the data. This is not intented to replace a full analysis in R or comparble statistical packages, but instead intended to allow the user to quickly access if the data is suitable for their needs.

Access to data packages on DataOne member notes is provided through the package metajam.

Install and run

# Install from the development branch for the time being
remotes::install_github("IMCR-Hackathon/datapie", ref = "development")
library(datapie)

# Run datapie
datapie_shiny()

Usage

TBD

Road map

  • Supplement reports with metadata if it exists.
  • Work with metajam to support other file formats (e.g. .xlsx).
  • Support other data types (e.g. spatial raster).
  • Create guidelines for integrating this app into data catalogs and websites.

Contributing

TBD

Versioning

This project uses semantic versioning.

Authors

TBD

Acknowledgements

This package was the product of the 2019 Information Management Code Registry Hackathon sponcered by the Environmental Data Initiative.

We are very greatful to Gert Stulp for their ggplotgui package form which this repository is forked.

Dr Stulp's orginal acknowledgement follows:

I am grateful to the people who made R, and to Hadley Wicham for making such good packages (and open access books describing them), that allow even low-skilled and low-talented programmers like myself to be able to contribute to R. This package makes use of: ggplot2, Shiny, stringr, plotly, readr, readxl, haven, and RColorBrewer. Package development through RStudio and Github, and with the help of R Markdown and devtools. The code that allows for online data input was based somewhat on the BoxPlotR Shiny app. Many thanks to Wilmer Joling who set up the illustrous "docker" and website where the online version of this packages runs.

About

Data Package Interface for Evaluation ("Easy as pie!")

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 95.3%
  • R 4.7%