# backbone <img src='man/figures/logo.png' align="right" height="139" />

<!-- badges: start -->
[![](https://www.r-pkg.org/badges/version/backbone?color=orange)](https://cran.r-project.org/package=backbone)
[![Downloads](https://cranlogs.r-pkg.org/badges/backbone?color=orange)](https://CRAN.R-project.org/package=backbone)
[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/backbone?color=orange)](https://CRAN.R-project.org/package=backbone)
[![status](https://tinyverse.netlify.app/badge/backbone)](https://CRAN.R-project.org/package=backbone)
[![DOI:10.1371/journal.pone.0269137](http://img.shields.io/badge/DOI-10.1371/journal.pone.0269137-B31B1B.svg)](https://doi.org/10.1371/journal.pone.0269137)
<!-- badges: end -->

## Welcome
The backbone package implements methods to extract the *backbone* of a network, which is a sparse and unweighted subgraph that contains only the most "important" or "significant" edges. A backbone can be useful when the original network is too dense, when edge weights are not needed, or when edge weights are difficult to interpret. Methods are available for:

* Weighted networks
* Weighted projections
* Unweighted networks

In addition, the package implements some other utility functions to:

* Randomize matrices while preserving the row and column sums using the fastball algorithm
* Estimate the Bipartite Configuration Model (BiCM)

For more details on these functions and methods, please see:

* `vignette("backbone")`
* Neal, Z.P. (2022). backbone: An R package to extract network backbones. *PLoS ONE, 17*, e0269137. <https://doi.org/10.1371/journal.pone.0269137>
* [www.rbackbone.net](https://www.zacharyneal.com/backbone)

## Installation
The /release branch contains the current CRAN release of the backbone package. You can install it from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("backbone")
```

The /devel branch contains the working beta version of the next release of the backbone package. All the functions are documented and have undergone various levels of preliminary debugging, so they should mostly work, but there are no guarantees. Feel free to use the devel version (with caution), and let us know if you run into any problems. You can install it You can install from GitHub with:
``` r
devtools::install_github("zpneal/backbone", ref = "devel", build_vignettes = TRUE)
```

## Dependencies
The `backbone` package adopts the [tinyverse](https://www.tinyverse.org/) philosophy, and therefore aims to keep dependencies at a minimum.
