Skip to content

Support matrix.mtx.gz cellbender remove-background input#11565

Open
alecw wants to merge 4 commits into
nf-core:masterfrom
alecw:alecw_cellbender_matrix_mtx
Open

Support matrix.mtx.gz cellbender remove-background input#11565
alecw wants to merge 4 commits into
nf-core:masterfrom
alecw:alecw_cellbender_matrix_mtx

Conversation

@alecw
Copy link
Copy Markdown

@alecw alecw commented May 7, 2026

cellbender remove-background can use as input the file triplet matrix.mtx.gz, barcodes.tsv.gz, features.tsv.gz. This change enables this input format via:

  • passing the 3 files in the h5ad input parameter;
  • and setting task.ext.input = '.', which tells remove-background to look for the 3 files in the working directory.

PR checklist

  • 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 necessary, include test data in your PR.
  • Remove all TODO statements.
  • Broadcast software version numbers to topic: versions - See version_topics
  • 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

alecw added 2 commits May 7, 2026 17:36
cellbender remove-background can use as input the file triplet matrix.mtx.gz,
barcodes.tsv.gz, features.tsv.gz.  This change enables this input format via:
- passing the 3 files in the h5ad input parameter;
- and setting task.ext.input = '.', which tells remove-background to look for the
  3 files in the working directory.
@alecw
Copy link
Copy Markdown
Author

alecw commented May 10, 2026

I am not able to run tests with nf-core modules test cellbender/removebackground --profile docker. I get an error that appears to be unrelated to this module.

I have submitted a PR in nf-core/test-datasets for 10X-style matrix market files. Rather than waiting for that PR to be merged, I was able to get nf-test test modules/nf-core/cellbender/removebackground/tests/main.nf.test --profile docker to pass by setting modules_testdata_base_path = 'https://raw.githubusercontent.com/alecw/nf-core_test-datasets/alecw_10x_mtx/data/'

I don't have easy access to a GPU so I haven't tested that flavor, but I believe I have demonstrated that 1) my change doesn't break the existing functionality; and 2) setting ext.input='.' works to read 10X-MatrixMarket.

@alecw alecw marked this pull request as ready for review May 10, 2026 17:57
@famosab
Copy link
Copy Markdown
Contributor

famosab commented May 11, 2026

Please join the nf-core organization on GitHub to enable the CI-tests to run on your PR. You can request to join the organization via #github-invitations in the nf-core slack. You can join the nf-core slack via https://nf-co.re/join.

@alecw
Copy link
Copy Markdown
Author

alecw commented May 11, 2026

Hi @famosab , thanks, I just joined the organization.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants