This repository contains code for the unicorn command line program:
./unicorn
unicorn 0.0.0
./unicorn command [options] -b <in.bam>|<in.sam>|<in.cram>
Commands:
alnstats Compute per alingments statitics such as:
# alingments, ANI, GC, etc.
refstats Compute per reference statistics such as
# alignments, # reads, mean read length, etc.
As well as for the unicorn library libunicorn which contains the project's functionality via
unicorn's API: unicorn.h
make
htslib >= 1.21
Running make in the base directory will build the entire porject into:
unicorn //Command line program
libunicorn.a //Static library
unicorn.h //API
You can supply a costum path to an alternative htslib instalation with HTSSRC. For example:
Assuming htslib is installed in:
/path/to/alternative/htslibinstall
$ ls /path/to/alternative/htslibinstall
lib
include
make HTSSRC=/path/to/alternative/htslibinstall
Will compile the entire project using the provided htslib instalation.
Just add unicorn.h to your program's source and compile with libunicorn.a
//test_unicorn.c
//gcc -Wall -Wextra -pedantic -std=c11 -o test_unicorn test_unicorn.c libunicorn.a -lhts
#include <stdio.h>
#include "unicorn.h"
int main()
{
fprintf(stderr, "Using unicorn version: ", unicorn_version());
return 0;
}
gcc -Wall -Wextra -pedantic -std=c11 -o test_unicorn test_unicorn.c libunicorn.a -lhts
$ ./test_unicorn
Using unicorn version: 0.0.0
Bugs and requests are handled via github issues
In order to contribute code, please refer to DEVELOP.md