Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

hiphase: stub output names differ from the real run (haplotagged BAMs and report files)

Chiusa Adatta ai principianti
  • Qualcosa non va?
#13,425 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Una pull request collegata è già stata integrata.

  • #13431 di @aksenia — integrata

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Ambito
bioinformatics, testing

Direzione di ricerca

Inizia dal blocco stub in modules/nf-core/hiphase/main.nf e confronta i nomi dei file che modifica con gli output effettivi dei comandi e i glob descritti nell’issue. Poi esamina i casi nf-test e lo snapshot di hiphase; il lavoro è completato quando le esecuzioni stub producono gli stessi nomi BAM e degli indici e i quattro nomi dei file dei report, un test copre due BAM di input e meta.yml documenta la convenzione di denominazione dei BAM.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

bug
Have you checked the docs?
Description of the bug

The HIPHASE stub writes different file names than the real run, so -stub output does not represent real output:

  1. Haplotagged BAMs. The script uses --output-bam ${file.baseName}_haplotagged.bam, but the stub touches ${prefix}_${file.baseName}_haplotagged.bam (same for the .bai/.csi index). Visible in the committed snapshot:

    • real: NA03697B2_downsampled.pbmm2.repeats_haplotagged.bam
    • stub: test_NA03697B2_downsampled.pbmm2.repeats_haplotagged.bam

    A pipeline that pairs output BAMs back to samples by name gets nothing under -stub. In genomic-medicine-sweden/nallo#1295 this let stub tests pass with an empty channel while real runs had a sample mix-up.

  2. Report files. The script writes ${prefix}.summary.${file_format}, ${prefix}.blocks.${file_format}, ${prefix}.stats.${file_format} and ${prefix}.haplotag.${file_format}, but the stub touches ${prefix}.${file_format} for all four, which matches none of the output globs (*.summary.tsv etc.). The summary_*, blocks_*, stats_* and haplotag_* channels are empty in the true - tsv - stub and true - csv - stub snapshots, while the corresponding real tests emit them.

Proposed fix:

  • Stub: touch ${file.baseName}_haplotagged.bam and index (no prefix), and ${prefix}.summary.${file_format} etc., matching the script.
  • Add a stub test with two input BAMs so the snapshot shows one output BAM per input with the expected names.
  • Document in meta.yml that output BAMs are named <input BAM basename>_haplotagged.bam, so callers can map outputs back to inputs by exact name.
Command used and terminal output
$ nf-test test modules/nf-core/hiphase/tests/main.nf.test --profile docker

No error; the mismatch is visible by comparing the real and stub entries in modules/nf-core/hiphase/tests/main.nf.test.snap (bams names differ; stub report-file channels are empty).

Relevant files
System information

Not environment-specific; found from the module code and committed snapshot at 32d9d7b (current master).

Lingua principale
Nextflow
Stelle
433
Fork
1.1k
Merge medio
9h 12m
PR unite (30g)
85

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di nf-core/modules

Tutte le issue di nf-core/modules

Issue simili

Altre issue su Bioinformatics

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.