README.rmd

---
output: github_document
---

# Visualise and Explore Deep Dependencies of R Packages <img src='man/figures/logo.png' align="right" height="180" />

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/deepdep)](https://CRAN.R-project.org/package=deepdep)
[![CircleCI build status](https://circleci.com/gh/DominikRafacz/deepdep.svg?style=svg)](https://circleci.com/gh/DominikRafacz/deepdep)
[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/DominikRafacz/deepdep?branch=master&svg=true)](https://ci.appveyor.com/project/DominikRafacz/deepdep)
[![Codecov test coverage](https://codecov.io/gh/DominikRafacz/deepdep/branch/master/graph/badge.svg)](https://codecov.io/gh/DominikRafacz/deepdep?branch=master)
[![Lifecycle: maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)

<!-- badges: end -->

## Overview

The `deepdep` package provides tools for exploration of package dependencies. The main `deepdep()` function allows to acquire deep dependencies of any package and plot them in an elegant way. It also adds some popularity measures for the packages e.g. in the form of download count through the `cranlogs` package. Uses the [CRAN metadata database](http://crandb.r-pkg.org) and [Bioconductor metadata](http://bioconductor.org). 

**Exploration tools:**

- `deepdep()`
- `get_dependencies()`
- `get_downloads()` 
- `get_description()` 

**Visualisation tools:**

- `plot_dependencies()`
- `plot_downloads()`
- `deepdep_shiny()` runs shiny application that helps to produce a nice **deepdep plot**

## Installation

```{r eval = FALSE}
# Install from CRAN: 
install.packages("deepdep")

# Install the development version from GitHub:
devtools::install_github("DominikRafacz/deepdep")
```

##  Examples [**introduction to the deepdep package**](https://dominikrafacz.github.io/deepdep/articles/deepdep-package.html)

```{r set-options, echo=FALSE, cache=FALSE}
options(width = 700)
```

```{r message=FALSE, warning=FALSE, fig.width=10, fig.height=7, fig.align='center'}
library(deepdep)

dd <- deepdep("ggplot2", depth = 2)

head(dd)

plot_dependencies(dd, "circular")
```

```{r message=FALSE, warning=FALSE, fig.width=10, fig.height=7, fig.align='center'}
plot_dependencies("bayes4psy", show_version = TRUE,
                  dependency_type = c("Depends", "Imports", "Suggests", "LinkingTo"))
```

```{r message=FALSE, warning=FALSE, fig.width=8, fig.height=6, fig.align='center'}
dd_xgboost <- deepdep("xgboost", dependency_type = "Imports", downloads = TRUE)

head(dd_xgboost)

plot_downloads(dd_xgboost)
```

```{r message=FALSE, warning=FALSE, fig.width=8, fig.height=5, fig.align='center'}
plot_dependencies(dd_xgboost, "tree", show_version = TRUE)
```

<!------------------------

This package was made during `1120-DS000-ISP-0500`[Advanced Programming in R](https://github.com/mini-pw/2020Z-ProgramowanieWR) course at Warsaw University of Technology.-->