Is there any C API documentation for HTSLIB?
1
3
Entering edit mode
8.1 years ago
chen ★ 2.5k

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?

htslib API Doc BAM • 6.0k views
ADD COMMENT
0
Entering edit mode

The library is actually built with Doxygen-friendly API formatting. I was able to generate a much more user-friendly API with Doxygen.

ADD REPLY
1
Entering edit mode
8.1 years ago

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

ADD COMMENT
0
Entering edit mode

Ok, thanks.

Do you share code on github?

ADD REPLY
0
Entering edit mode
ADD REPLY
0
Entering edit mode

Cool, studying now...

ADD REPLY
0
Entering edit mode

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.

ADD REPLY
1
Entering edit mode

You don't need samtools, yes you will want to compile and install htslib so you can link against it.

ADD REPLY
0
Entering edit mode

Thanks for fast respond.

ADD REPLY

Login before adding your answer.

Traffic: 1578 users visited in the last hour
Help About
FAQ
Access RSS
API
Stats

Use of this site constitutes acceptance of our User Agreement and Privacy Policy.

Powered by the version 2.3.6