Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add index format to samtools view #7481

Open
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

fellen31
Copy link
Contributor

@fellen31 fellen31 commented Feb 14, 2025

Adds an index_format that specifies index generation explicitly (as suggested by @SPPearce), while still allowing for ext.args to contain --write-index (which generates the index with the default samtools index format for the filetype).

Would supersede #4326.

Also:

  • fixes stub with unselected.
  • Port bam_split_by_region to nf-test.

PR checklist

Closes #XXX

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the module conventions in the contribution docs
  • If necessary, include test data in your PR.
  • Remove all TODO statements.
  • Emit the versions.yml file.
  • Follow the naming conventions.
  • Follow the parameters requirements.
  • Follow the input/output options guidelines.
  • Add a resource label
  • Use BioConda and BioContainers if possible to fulfil software requirements.
  • Ensure that the test works with either Docker / Singularity. Conda CI tests can be quite flaky:
    • For modules:
      • nf-core modules test <MODULE> --profile docker
      • nf-core modules test <MODULE> --profile singularity
      • nf-core modules test <MODULE> --profile conda
    • For subworkflows:
      • nf-core subworkflows test <SUBWORKFLOW> --profile docker
      • nf-core subworkflows test <SUBWORKFLOW> --profile singularity
      • nf-core subworkflows test <SUBWORKFLOW> --profile conda

@fellen31 fellen31 force-pushed the samtools-view-index-type branch from 4d38e7a to bb3ec89 Compare February 14, 2025 07:55
@fellen31 fellen31 changed the title Add output index type to samtools view Add index format to samtools view Feb 14, 2025
@fellen31 fellen31 force-pushed the samtools-view-index-type branch 6 times, most recently from de3c4c1 to 161a736 Compare February 14, 2025 09:44
@fellen31 fellen31 marked this pull request as ready for review February 14, 2025 09:46
@fellen31 fellen31 requested a review from a team as a code owner February 14, 2025 09:46
@fellen31
Copy link
Contributor Author

I believe all remaining lint and pytest-workflow failures are not due to updating this module, but other module updates that I can't adress in this PR.

@SPPearce
Copy link
Contributor

It is trying to lint top-level tools again, rather than the subtool :|
e.g.

Run Linting / nf-core lint modules (graphtyper)

@fellen31
Copy link
Contributor Author

It is trying to lint top-level tools again, rather than the subtool :| e.g.

Run Linting / nf-core lint modules (graphtyper)

Can we exclude the pytests tests/ directory from the CI? Guessing that is why it's trying to lint top-level?

@fellen31 fellen31 force-pushed the samtools-view-index-type branch 6 times, most recently from d13abb1 to 16f4dc2 Compare February 14, 2025 11:06
@fellen31
Copy link
Contributor Author

It is trying to lint top-level tools again, rather than the subtool :| e.g.

Run Linting / nf-core lint modules (graphtyper)

Making a separate PR: #7482

@fellen31 fellen31 force-pushed the samtools-view-index-type branch from de13679 to 227172b Compare February 26, 2025 09:51
@fellen31
Copy link
Contributor Author

Thanks for fixing graphtyper @SPPearce. The remaining pytest is failing because:

Process `test_fastq_create_umi_consensus_fgbio_single_umi:FASTQ_CREATE_UMI_CONSENSUS_FGBIO:FILTERCONSENSUS` declares 5 input channels but 2 were specified
Process `test_fastq_create_umi_consensus_fgbio_duplex_umi:FASTQ_CREATE_UMI_CONSENSUS_FGBIO:CALLDUPLEXCONSENSUS` declares 3 input channels but 1 were specified

This has nothing to do with the changes in this PR, and I don't really understand the subworkflow well enough to fix it. Could we ignore this?

@SPPearce
Copy link
Contributor

Yeah, that subworkflow is broken already by the looks of it at the moment.

@SPPearce
Copy link
Contributor

Looks like I broke it when I updated the fgbio modules, but the subworkflow tests didn't run: #5624

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants