Indexes.jl

Author BioJulia
Popularity
2 Stars
Updated Last
1 Year Ago
Started In
October 2018

Indexes.jl

Project Status: Active – The project has reached a stable, usable state and is being actively developed. Latest Release MIT license Stable documentation Latest documentation Join the chat at https://gitter.im/BioJulia/Indexes.jl

This project follows the semver pro forma and uses the git-flow branching model.

Description

Handles indexes required to iterate through various IO streams. For example:

  • Generic index for tab-delimited files.
  • An index type for BGZFStream.

Installation

The Indexes package is bundled into packages like BED, GFF3, and XAM to assist them with IO streams, so you may not need to install this package explicitly. However, if you do, Indexes is made available to install through the [https://github.com/juliaregistries/General](General package registry).

You can install Indexes from the Julia REPL. Press ] to enter pkg mode, then enter the following command:

add Indexes

If you are interested in the cutting edge of the development, please check out the develop branch to try new features before release.

Testing

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

Latest build status:

Unit tests Documentation codecov

Contributing

We appreciate contributions from users including reporting bugs, fixing issues, improving performance and adding new features.

Take a look at the contributing files detailed contributor and maintainer guidelines, and code of conduct.

Financial contributions

We also welcome financial contributions in full transparency on our open collective. 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.

backers

Does your company use BioJulia? Help keep BioJulia feature rich and healthy by sponsoring the project. Your logo will show up here with a link to your website.

Questions?

If you have a question about contributing or using BioJulia software, come on over and chat to us on Gitter, or you can try the Bio category of the Julia discourse site.