I couldn't find any API documentation for HTSLIB C implementation. And I even failed to find tutorials for using HTSLIB C library to read BAM/BCF or other files.
Does anyone know where is its doc?
•
written
by
chen
1 answer
The documentation is mostly just the header files in the htslib/ subdirectory. If you have any questions on usage, you can probably get decently quick replies here (at least I've made fairly heavy use of the API over the years, though I've never needed to deal with the BCF side).
Certainly :)
Dear Devon I have problem with its compilation. Would you please tell me how I should start? In a simple case, I want to use #include "htslib/sam.h". Should I build samtools and htslib beforehand? when I want to compile, should I add the address using -I and -L ? thank you in advance.
You don't need samtools, yes you will want to compile and install htslib so you can link against it.
Thanks for fast respond.
Log in to answer this question.
-
Converting bam to sam using htslib C++ api
written by Uveyik •
-
cd-hit-est obscure parameter -b
written by biofalconch
-
Example of simple repository using htslib API to read in .bcf
written by 4galaxy77
-
Coverage data for TCGA BAM files
written by enho •
-
Issue getting right strand in ccat
written by blur
-
How to get a list of aligned read and reference positions using samtools
written by Aref.Ariyapour •
-
Is BioDAS still active? If not, is there an alternative?
written by JJ Gao
-
Resources to learn htslib and C/C++
written by QVINTVS_FABIVS_MAXIMVS
-
htslib C API: getting reads from region
written by QVINTVS_FABIVS_MAXIMVS
-
Error with bam-window
written by ivivek_ngs
The library is actually built with Doxygen-friendly API formatting. I was able to generate a much more user-friendly API with Doxygen.