Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Cerrado Apto para principiantes
  • ¿Algo no está bien?
#13,425 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Ya se ha fusionado un pull request relacionado.

  • #13431 de @aksenia — fusionado

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
78/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Área
bioinformatics, testing

Línea de trabajo

Empieza por el bloque stub de modules/nf-core/hiphase/main.nf y compara los nombres de archivo que modifica con las salidas reales de los comandos y los globs descritos en el issue. Después, revisa los casos de nf-test y el snapshot de hiphase; el trabajo estará listo cuando las ejecuciones stub produzcan los mismos nombres de BAM e índices y los cuatro nombres de archivo de los informes, haya una prueba que cubra dos BAM de entrada y meta.yml documente la nomenclatura de los BAM.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Nextflow
Estrellas
433
Forks
1.1k
Merge medio
13 h 30 min
PR fusionados (30 d)
222

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de nf-core/modules

Todos los issues de nf-core/modules

Issues similares

Más issues de Bioinformatics

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.