docs.rs failed to build rust-htslib-0.3.1
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build:
rust-htslib-0.46.0
HTSlib bindings for Rust
This library provides HTSlib bindings and a high level Rust API for reading and writing BAM files.
To clone this repository, issue
git clone --recursive https://github.com/christopher-schroeder/rust-htslib.git
ensuring that the HTSlib submodule is fetched, too.
Usage
To use Rust-HTSlib in your Rust project, import the crate from your source code:
extern crate htslib;
use bam;
Rust-HTSlib provides a high level BAM API. Reading and writing BAM files is as easy as
let bam = new;
let out = with_template;
// copy reverse reads to new BAM file
for r in bam.records
Pileups can be performed with
let bam = new;
// pileup over all covered sites
for p in bam.pileup
In both cases, indexed BAM files can be seeked for specific regions, constraining either the record iterator or the pileups:
let bam = new;
// seek to chr1:50000-100000
bam.seek.ok.expect;
// afterwards, read or pileup in this region
Authors
- Christopher Schröder (christopher.schroeder@tu-dortmund.de)
- Johannes Köster (johannes.koester@tu-dortmund.de)
License
Licensed under the MIT license http://opensource.org/licenses/MIT. This project may not be copied, modified, or distributed except according to those terms.