Giter VIP home page Giter VIP logo

fastjac's Introduction

fastjac

A simple program for getting k-mer similarity metrics for two fastq/fasta files, written in Rust.

Description

This command line program takes as inputs two fastq/fasta file and a k-mer size and outputs the following k-mer similarity metrics:

  • Jaccard distance - the ratio of intersection over union for the two k-mer sets.

  • Sørensen-Dice coefficient - twice the number of elements common to both sets divided by the sum of the number of elements in each set.

  • Containment - fraction of the k-mers in the query which are found in the reference.

If the cardinality of the k-mers in A is smaller than in B then this is the same as the overlap coefficient.

Install

I provide precompiled binaries for linux only here, but it is simple to compile and run:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
git clone https://github.com/angelovangel/fastjac.git

cd fastjac
cargo build --release

The executable file fastjac is now under ./target/release/

Usage

The main options are -k k-mer size to use, -q path to query sequence file and -r path to reference sequence file. Both fasta and fastq (also compressed) are supported. Try fastjac -h for all options.

The output is a tab-separated table with the lengths of the k-mer sets, intersection, union, Jaccard distance, Sørensen-Dice coefficient, and containment (fraction of k-mers of query found in reference).

fastjac's People

Contributors

angelovangel avatar

Stargazers

 avatar  avatar

Watchers

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