https://github.com/biojulia/bbi.jl

https://github.com/biojulia/bbi.jl

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/biojulia/bbi.jl
• Owner: BioJulia
• License: mit
• Created: 2018-10-09T02:10:50.000Z (over 7 years ago)
• Default Branch: develop
• Last Pushed: 2020-06-21T00:13:41.000Z (almost 6 years ago)
• Last Synced: 2025-04-11T12:51:57.170Z (about 1 year ago)
• Language: Julia
• Size: 169 KB
• Stars: 4
• Watchers: 11
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
#  BBI.jl

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![Latest Release](https://img.shields.io/github/release/BioJulia/BBI.jl.svg)](https://github.com/BioJulia/BBI.jl/releases/latest)

[![MIT license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/BioJulia/BBI.jl/blob/master/LICENSE)

[![Stable documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://biojulia.github.io/BBI.jl/stable)

[![Latest documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://biojulia.github.io/BBI.jl/dev/)

[![Join the chat at https://gitter.im/BioJulia/BBI.jl](https://badges.gitter.im/BioJulia/BBI.jl.svg)](https://gitter.im/BioJulia/BBI.jl)

> This project follows the [semver](http://semver.org) pro forma and uses the [git-flow branching model](https://nvie.com/posts/a-successful-git-branching-model/ "original blog post").

## Description

BBI.jl handles the shared parts of [bigWig.jl](https://github.com/BioJulia/bigWig.jl) and [bigBed.jl](https://github.com/BioJulia/bigBed.jl).

## Installation

The BBI package is bundled into the [bigWig](https://github.com/BioJulia/bigWig.jl) and [bigBed](https://github.com/BioJulia/bigBed.jl) packages, so you may not need to install this package explicitly.

However, if you do, BBI is made available to install through the [https://github.com/juliaregistries/General](General package registry).

You can install BBI from the [Julia REPL](https://docs.julialang.org/en/v1/manual/getting-started/).

Press `]` to enter [pkg mode](https://docs.julialang.org/en/v1/stdlib/Pkg/), then enter the following command:

```julia

add BBI

```

If you are interested in the cutting edge of the development, please check out the [develop branch](https://github.com/BioJulia/BBI.jl/tree/develop) to try new features before release.

## Testing

BBI is tested against Julia `1.X` on Linux, OS X, and Windows.

**Latest build status:**

[![Unit tests](https://github.com/BioJulia/BBI.jl/workflows/Unit%20tests/badge.svg?branch=master)](https://github.com/BioJulia/BBI.jl/actions?query=workflow%3A%22Unit+tests%22+branch%3Amaster)

[![Documentation](https://github.com/BioJulia/BBI.jl/workflows/Documentation/badge.svg?branch=master)](https://github.com/BioJulia/BBI.jl/actions?query=workflow%3ADocumentation+branch%3Amaster)

[![codecov](https://codecov.io/gh/BioJulia/BBI.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/BioJulia/BBI.jl)

## Contributing

We appreciate [contributions](https://github.com/BioJulia/BBI.jl/graphs/contributors) from users including reporting bugs, fixing issues, improving performance and adding new features.

Take a look at the [contributing files](https://github.com/BioJulia/Contributing) detailed contributor and maintainer guidelines, and code of conduct.

### Financial contributions

We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/biojulia).

Anyone can file an expense.

If the expense makes sense for the development the core contributors and the person who filed the expense will be reimbursed.

## Backers & Sponsors

Thank you to all our backers and sponsors!

Love our work and community? [Become a backer](https://opencollective.com/biojulia#backer).

[![backers](https://opencollective.com/biojulia/backers.svg?width=890)](https://opencollective.com/biojulia#backers)

Does your company use BioJulia?

Help keep BioJulia feature rich and healthy by [sponsoring the project](https://opencollective.com/biojulia#sponsor).

Your logo will show up here with a link to your website.

[![](https://opencollective.com/biojulia/sponsor/0/avatar.svg)](https://opencollective.com/biojulia/sponsor/0/website)

[![](https://opencollective.com/biojulia/sponsor/1/avatar.svg)](https://opencollective.com/biojulia/sponsor/1/website)

[![](https://opencollective.com/biojulia/sponsor/2/avatar.svg)](https://opencollective.com/biojulia/sponsor/2/website)

[![](https://opencollective.com/biojulia/sponsor/3/avatar.svg)](https://opencollective.com/biojulia/sponsor/3/website)

[![](https://opencollective.com/biojulia/sponsor/4/avatar.svg)](https://opencollective.com/biojulia/sponsor/4/website)

[![](https://opencollective.com/biojulia/sponsor/5/avatar.svg)](https://opencollective.com/biojulia/sponsor/5/website)

[![](https://opencollective.com/biojulia/sponsor/6/avatar.svg)](https://opencollective.com/biojulia/sponsor/6/website)

[![](https://opencollective.com/biojulia/sponsor/7/avatar.svg)](https://opencollective.com/biojulia/sponsor/7/website)

[![](https://opencollective.com/biojulia/sponsor/8/avatar.svg)](https://opencollective.com/biojulia/sponsor/8/website)

[![](https://opencollective.com/biojulia/sponsor/9/avatar.svg)](https://opencollective.com/biojulia/sponsor/9/website)

## Questions?

If you have a question about contributing or using BioJulia software, come on over and chat to us on [Gitter](https://gitter.im/BioJulia/General), or you can try the [Bio category of the Julia discourse site](https://discourse.julialang.org/c/domain/bio).