Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/alignment.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,16 @@ inline void append_cigar_operation(const int length, const char operation, vecto
* tlen_max is given, it is a limit on the magnitude of tlen to consider the
* read properly paired.
*
* @param[in] bam_header the file's metadata
* @param[in] alignment vg's representation of the read (name, sequence, quality scores)
* @param[in] refseq (reference sequence) what chromosome it was placed on (chr1)
* @param[in] refpos (reference position) what sequence offset it was placed at on that chromosome
* (124566). This follows SAM/BAM conventions, and gives the lowest position in the reference
* regardless of read orientation.
* @param[in] refrev (reference reverse-ness) whether it was placed on the reverse strand (true) or
* forward strand (false)
* @param[in] cigar the alignment description (50M 2I)
*
* Remember to clean up with bam_destroy1(b);
*/
bam1_t* alignment_to_bam(bam_hdr_t* bam_header,
Expand Down
Loading