Draft
Conversation
v1.2.4 - Bouncy Basenji Patch PR
v1.2.5 - Bouncy Basenji Patch PR
v1.2.6 - Bouncy Basenji Patch PR
…profiler into singlem
…gle m, either singularity or conda environments.
… to that directory in the database csv
Member
|
@dgodin19 confirmed on Slack this was a hackathon project, and likely would not be able to continue However this is a good scaffold we can continue from (thank you for kicking it off @dgodin19 !), so we leave the Some initial notes from a quick review:
But the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR is an initial attempt to add support for SingleM to the profiling layer of the pipeline.
This work was started during the March 2026 nf-core hackathon by Dennis and Jack.
Changes
The following changes were made:
singlemmodule to modules/nfcore/singlem/singlemprofiling.nfsubworkflownextflow.configsamplesheet.csvanddatabases.csvfiles for testingRunning the module
I was able to run the module successfully with:
nextflow run main.nf -profile conda --input samplesheet.csv --databases databases.csv --outdir test_outDatabase setup
SingleM requires pre-downloaded marker gene data. This must currently be done manually before running the pipeline.
Example workflow:
Create a conda environment with SingleM
Run:
singlem data --output-directory /path/to/dbsAdd the resulting directory to the
databases.csvExample database and sample sheets have been included in the repository for reference.
Container issues
I attempted to run the module with both Docker and Singularity profiles. However, I encountered an error related to the
-psoption in Nextflow. The exact error was something like:Command error: Command 'ps' required by nextflow to collect task metrics cannot be foundThe container referenced in the SingleM documentation appears to be minimal and may be read-only. Because of this, it may be preferable to build a custom container including:
and publish it to quay.io.
Remaining issues / TODO
The module produces output, but there are still some integration steps remaining:
I started reviewing taxpasta documentation but did not complete this integration.
Notes
This PR is intended as a starting point for discussion and further development.