Skip to content

Latest commit

 

History

History
82 lines (61 loc) · 2.36 KB

README.md

File metadata and controls

82 lines (61 loc) · 2.36 KB
Raw

maintaineR

maintaineR is both a package to analyze CRAN packages and a web dashboard to visualize results of the analysis.

Prerequisites

maintaineR package depends on the following packages:

  • R
  • igraph
  • rCharts
  • d3Network
  • RCurl

The web dashboard depends on the following additional packages:

You will also need data. The entire data set can be obtained from our CRANData repository. However the Shiny web app allows one to download only a subset of the data.

Available online data was extracted using extractoR, timetraveleR and cloneR.

This allows you to download only data files you need for a subset of packages. By default the Shiny app will download general CRAN data (packages, dependencies, conflicts and clones) and will only download packages specific data (DESCRIPTION file, functions list and namespaces) when requested by the user. Options allows one to download more data with each selected package like direct and reverse dependencies, conflicting packages and cloned packages.

Usage

First download and install required packages:

install.packages(c("igraph", "d3Network", "shiny", "RCurl", "devtools"))
devtools::install_github("rstudio/shiny-incubator")
devtools::install_github("ramnathv/rCharts")
devtools::install_github("ecos-umons/extractoR/extractoR.utils")
devtools::install_github("ecos-umons/maintaineR")

Then data are needed, they can be gotten either:

git clone https://github.com/maelick/CRANData.git <dest>

Or by using maintaineR shiny web app.

Finally shiny web app can be run:

shiny::runApp(system.file("webapp", package="maintaineR"), port=3000)

By default the app will store downloaded data in the package installation folder (inside "data" subfolder). If all data are retrieved using git, they must be stored there. Alternately the directory where data are stored can be modified in by defining a "datadir" variable before running the app.

Demo

A screencast demo is available on Youtube and presentation slides from useR 2014 here.