Code Monkey home page Code Monkey logo

best's Introduction

best

Bam Error Stats Tool (best): analysis of error types in aligned reads.

best is used to assess the quality of reads after aligning them to a reference assembly.

Features

  • Collect overall and per alignment stats
  • Distribution of indel lengths
  • Yield at different empirical Q-value thresholds
  • Bin per read stats to easily examine the distribution of errors for certain types of reads
  • Stats for regions specified by intervals (BED file, homopolymer regions, windows etc.)
  • Stats for quality scores vs empirical Q-values
  • Multithreading for speed

Usage

The best Usage Guide gives an overview of how to use best.

Installing

  1. Install Rust.
  2. Clone this repository and navigate into the directory of this repository.
  3. Run cargo install --locked --path .
  4. Run best input.bam reference.fasta prefix/path

This will generate stats files with the prefix/path prefix.

Development

Running

  1. Install Rust.
  2. Clone this repository and navigate into the directory of this repository.
  3. Run cargo build --release
  4. Run cargo run --release -- input.bam reference.fasta prefix/path or target/release/best input.bam reference.fasta prefix/path

This will generate stats files with the prefix/path prefix.

The built binary is located at target/release/best.

Formatting

cargo fmt

Comparing

Remember to pass the -t 1 option to ensure that only one thread is used for testing. Best generally tries to ensure the order of outputs is deterministic with multiple threads, but the order of per-alignment stats is arbitrary unless only one thread is used.

Disclaimer

This is not an official Google product.

The code is not intended for use in any clinical settings. It is not intended to be a medical device and is not intended for clinical use of any kind, including but not limited to diagnosis or prognosis.

No representations or warranties are made with regards to the accuracy of results generated. User or licensee is responsible for verifying and validating accuracy when using this tool.

best's People

Contributors

armintoepfer avatar daniel-liu-c0deb0t avatar danielecook avatar pichuan avatar ykozxy avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.