epam / epam/NGB

Bam/CRAM file consistency validation before registering

Open
#175 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
171
Forks
43
PR merge metrics
No merged PRs in 30d

Description

When registering bam files via the NGB cli, it makes no difference between a consistent and truncated bam file and registers both successfully. But when you look at he registered truncated file via the GUI, the file has no reads in it, that makes it absolutely useless.

I'd like to suggest the implement the consistency check for the alignment files. I think it could be done the same way as in samtools ([Source code](https://github.com/samtools/samtools/blob/develop/bam_quickcheck.c)) or the in Picard toolkit way([Source code](https://github.com/gkno/picard/blob/master/src/java/net/sf/picard/sam/ValidateSamFile.java)) - it also works for sam files

The cram files are checked for consistency approximately the same way, as I could understand.

Thank you very much!

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by tracing the NGB CLI registration path for BAM and CRAM files, then compare its behavior with the linked samtools bam_quickcheck.c and Picard ValidateSamFile.java sources. Done means truncated alignment files are rejected before registration while consistent BAM, CRAM, and SAM files continue to register successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend, cli
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.