https://github.com/jakubsob/functionexplorer

Shiny app for exploring function dependencies of given repository
https://github.com/jakubsob/functionexplorer

Last synced: 23 days ago
JSON representation

Shiny app for exploring function dependencies of given repository

• Host: GitHub
• URL: https://github.com/jakubsob/functionexplorer
• Owner: jakubsob
• License: other
• Created: 2020-12-03T21:27:58.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-12-29T21:47:57.000Z (about 4 years ago)
• Last Synced: 2024-10-30T00:38:55.622Z (2 months ago)
• Language: R
• Homepage:
• Size: 733 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# functionExplorer

[![R build status](https://github.com/jakubsob/functionExplorer/workflows/R-CMD-check/badge.svg)](https://github.com/jakubsob/functionExplorer/actions)

[![Travis build status](https://img.shields.io/travis/com/jakubsob/functionExplorer.svg?logo=travis)](https://travis-ci.com/jakubsob/functionExplorer)

[![Codecov test coverage](https://codecov.io/gh/jakubsob/functionExplorer/branch/master/graph/badge.svg)](https://codecov.io/gh/jakubsob/functionExplorer?branch=master)

[![license](https://img.shields.io/badge/license-mit-lightgrey.svg)](https://choosealicense.com/)

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

A Shiny app for exploring dependencies between functions from selected GitHub repository. Uses shiny.semantic.

## Installation

Install from GitHub:

```{r, eval = FALSE}

devtools::install_github("jakubsob/functionExplorer")

```

and run:

```{r, eval = FALSE}

functionExplorer::run_app()

```

## User Interface

The app opens to the following interface:

```{r, echo = FALSE, fig.cap = "Start page of app."}

knitr::include_graphics("man/figures/README-load-data.png")

```

To show tutorial on how to use click question mark button in top right corner.

To download data use download button to open modal and fill in name of repository to download:

```{r, echo = FALSE, fig.cap = "Data downloading popup."}

knitr::include_graphics("man/figures/README-load-data-popup.png")

```

After download use button to parse data:

```{r, echo = FALSE, fig.cap = "Tables with loaded and parsed data."}

knitr::include_graphics("man/figures/README-downloaded-data.png")

```

Go to graph tab to view plotted network:

```{r, echo = FALSE, fig.cap = "Function dependencies network."}

knitr::include_graphics("man/figures/README-plot-all.png")

```

Select node based on value from select input in sidebar or by clicking node on graph:

```{r, echo = FALSE, fig.cap = "Function dependencies network with selected node."}

knitr::include_graphics("man/figures/README-plot-node.png")

```