Filter of Pairwise Alignement
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.gitignore
.travis.yml
Cargo.lock
Cargo.toml
LICENSE
Readme.md

Readme.md

fpa Filter Pairwise Alignment

Build Status

Filter output of all-against-all read mapping, you filter or select:

  • internal match
  • containment
  • dovetails
  • self matcing
  • read name match against regex

All this filter can be revert.

For internal match, containment, dovetails definition go read algorithm 5 in minimap article

Usage

fpa <option> <output> <input>…

By default input and output are stdin and stdout so you can use like this:

minimap2 long_read.fasta long_read.fasta | fpa -d | gzip - > long_read_dovetail.paf.gz
minimap2 long_read.fasta long_read.fasta | fpa -l 500 -L 2000 > match_between_500_2000.paf
minimap2 long_read.fasta long_read.fasta | fpa -s -m read_1 > no_self_match_no_read_1.paf
minimap2 long_read.fasta long_read.fasta | fpa -s -r rename.csv > no_self_match_renamed_read_1.paf
minimap2 long_read.fasta long_read.fasta | fpa -s -r rename.csv -o gfa1 > no_self_match_renamed_read_1.gfa

Rename option

The renaming option replaces the name of the read with another one.

If the path passed in parameter exists, the file will be read as a two-column csv, the first column is the original name and the second corresponds to the new name:

original name1, new name1
original name2, new name2

If the name of the read does not exist in the file it will not be replaced.

If the path passed as parameter does not exist, the names will automatically be replaced by a number, a file like above example will be created.

Output mode

You can get an output in gfa format with the -o option (--output-mode), two modes are available:

  • basic: the output and in the format that the input
  • gfa1: the output is in gfa1 format

In gfa1 mode options -C and -I indicate that containments and internalmatches are included in the gfa (default option enabled), -c and -i indicate that containments and internalmatches should not be included.

Rationale

Long Read mapping tools provides all match they found in read dataset, for many usage some of match aren't usfull, this programme provide some filter to remove it. This soft can be replace by a simple awk, bash, python, perl, {your favorite language}.

Requirements

  • Rust in stable channel
  • libgz
  • libbzip2
  • liblzma

Instalation

With cargo

If you have a rust environment setup you can run :

cargo install fpa_lr

With conda

fpa is avaible in bioconda channel

if bioconda channel is setup you can run :

conda install fpa

From source

git clone https://github.com/natir/fpa.git
cd fpa
git checkout v0.3

cargo build
cargo test
cargo install