millironx/XAM.jl
1
0
Fork 0
mirror of https://github.com/MillironX/XAM.jl.git synced 2024-12-23 13:28:16 +00:00
Code Issues Releases Packages Activity
Parse and process SAM and BAM formatted files
50 commits 21 branches 10 tags 2.5 MiB
Julia 100%
Find a file
Ciarán O'Mara 429f69d84b Merge branch 'master' into develop
2020-03-21 17:28:02 +11:00
.github Add documentation workflow 2020-02-28 12:27:34 +11:00
coverage Continuous Integration 2020-02-20 10:19:27 +11:00
docs Correct link 2020-03-21 09:40:58 +11:00
src Merge branch 'master' into develop 2020-03-21 17:28:02 +11:00
test Check header in roundtrip 2020-03-21 17:16:14 +11:00
.codecov.yml Continuous Integration 2020-02-20 10:19:27 +11:00
.gitignore Initial commit 2020-01-17 16:30:35 +11:00
ci_prep.jl Continuous Integration 2020-02-20 10:19:27 +11:00
LICENSE Initial commit 2020-01-17 16:30:35 +11:00
Project.toml Increment version 2020-03-21 00:41:24 +11:00
README.md Update project status 2020-02-28 14:30:56 +11:00

README.md

XAM.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/XAM.jl

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

Description

XAM provides I/O and utilities for manipulating SAM and BAM formatted alignment map files.

Installation

The latest version of XAM is made available to install through BioJulia's package registry. By default, Julia's package manager only includes the "General" package registry.

To add the BioJulia registry from the Julia REPL, press ] to enter pkg mode, then enter the following command:

registry add https://github.com/BioJulia/BioJuliaRegistry.git

Once the registry is added to your configuration, you can install XAM while in pkg mode with the following:

add XAM

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

Testing

XAM 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.