aboutsummaryrefslogtreecommitdiff
path: root/README
blob: 87b50eec703630ba64de30532f4b4f498bdaec0a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
This is a reimplementation of Xenomapper [1] in Haskell.  Unlike the
orginal it is significantly more focused in scope: only primary specific
alignments are output.

Example usage: "xenomapper-hs primary-specific.bam primary.bam secondary.bam"

The first argument is the output bam path, and the subsequent are the
primary and secondary alignments. NB: the inputs must be name sorted
and the output will be name sorted.

Building the binary requires a flake enabled Nix [2]. Run

  nix build git://vk3.wtf/xenomapper-hs.git

to build, or if you have already cloned the repository then simply

  nix build

in the root.

--
1: https://github.com/genomematt/xenomapper
2: https://nixos.org/Nix