Skip to content

[PSEUDO-PR - DO NOT MERGE] core team release review - #79

Draft
jfy133 wants to merge 353 commits into
TEMPLATEfrom
dev
Draft

jfy133 wants to merge 353 commits into
TEMPLATEfrom
dev

Conversation

@jfy133

@jfy133 jfy133 commented Aug 19, 2026

Copy link
Copy Markdown
Member

This PR SHOULD NOT BE MERGED, and is only used for a 'clean' reviewing experience of dev against the latest template (vs. main, which will have an older version of the template).

vinisalazar and others added 4 commits August 5, 2026 12:38
Removes three things that were documented or declared but never wired up:
the `profileUsesContainers` variable left behind when its guard was deleted,
the commented-out igenomes params, and `save_runmerged_reads`, which was in
the schema and advertised FASTQ output the pipeline never publishes.

Also moves the profile subworkflow helpers below the workflow bodies, trims
the eggNOG-mapper publishDir comment, and converts the remaining GitHub-style
admonitions in usage.md and output.md to the nf-core website syntax, fixing
an unclosed `::` block in the process.

Co-authored-by: Jonas Scheid <43858870+jonasscheid@users.noreply.github.com>
FastQC was never called, so the citation claimed a tool that never ran.
Also carries over the database version table from #76.
@github-actions

github-actions Bot commented Aug 19, 2026

Copy link
Copy Markdown

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 5b44f88

+| ✅ 205 tests passed       |+
#| ❔   5 tests were ignored |#
!| ❗   3 tests had warnings |!
Details

❗ Test warnings:

  • nextflow_config - Config manifest.version should end in dev: 1.0.0
  • readme - README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
  • pipeline_todos - TODO string in CHANGELOG.md: ## v1.0.0 - [unreleased replace with date on release ]

❔ Tests ignored:

  • files_unchanged - File ignored due to lint config: .github/PULL_REQUEST_TEMPLATE.md
  • files_unchanged - File ignored due to lint config: .github/workflows/branch.yml
  • files_unchanged - File ignored due to lint config: .github/workflows/linting.yml
  • files_unchanged - File ignored due to lint config: assets/nf-core-funcprofiler_logo_light.png
  • files_unchanged - File ignored due to lint config: .gitignore or .prettierignore

✅ Tests passed:

Run details

  • nf-core/tools version 4.1.0
  • Run at 2026-09-17 21:10:08

Comment thread .devcontainer/setup.sh Outdated
Comment thread assets/pipeline_nf-core.svg
Comment thread assets/schema_database.json Outdated
Comment thread assets/schema_database.json Outdated
Comment thread assets/schema_database.json Outdated
Comment thread workflows/funcprofiler.nf Outdated
Comment thread CHANGELOG.md
Comment thread nextflow_schema.json Outdated
Comment thread nextflow_schema.json Outdated
Comment thread nextflow_schema.json Outdated
Samplesheet rows are validated and turned into their final [meta, [reads]]
form in PIPELINE_INITIALISATION, so a bad sheet aborts before any task is
submitted; DATAPREP now only merges runs and concatenates. The platform,
fastq_1 and long-read checks move into assets/schema_input.json, which no
longer offers OXFORD_NANOPORE or PACBIO_SMRT. validateProfilerDatabases()
does the same for the database sheet, replacing the lazy checks inside
getDbPath() and the fmhfunprofiler db_params check inside PROFILE. Drops
the unread db_type column from the database schema.
Drops leftover debug output and a duplicated ${args} from HUMANN4, adds a
header comment saying why the humann4 modules are local, and credits the
authors who modified them.
tests/nextflow.config goes back to the template shape so -profile test can
be run without nf-test, and test_full says why some profilers are off.
One sentence per line, GitHub admonitions instead of Astro, output file
lists in collapsible blocks, a database-preparation section per tool, and
the db_name/db_entity distinction spelled out before the examples.
Drops the preprocessing node, which 1.0.0 does not have, and collapses the
per-profiler lines into reads, databases, profiles and logs.
Replaces the map with the version drawn for the ISME20 poster, which was
laid out against nf-core/taxprofiler's tube map and answers the review
comments asking for fewer lanes.

Six lines instead of eleven: short reads, concatenated reads, summary
statistics, and a three-strand database bundle collapsed into one legend
row. Blue stops at run merging and green carries every profiler, RGI
included; that is a simplification, since RGI is fed the unconcatenated
reads. MetaPhlAn is drawn as the HUMAnN prescreen, the seven profiler
outputs converge on an unnamed junction that splits once to the tables
and to MultiQC, and hollow versus filled markers separate the opt-in
profilers from what runs by default.

The section holding MERGE_RUNS is called "Run merging", not
"Preprocessing": 1.0.0 does no read QC.
@vinisalazar

vinisalazar commented Sep 1, 2026

Copy link
Copy Markdown
Collaborator

Thanks @jfy133, I believe I addressed most of the comments, point by point below:

Applied commits:

Schemas and inputs

Docs

Modules

Subworkflows

Tests

  • tests/nextflow.config shouldn't be edited / weird indentation reverted to the template; all pipeline test settings moved into conf/test.config and conf/test_full.config, so the profiles run without nf-test.
  • Why are these off in the AWS megatest? kept off, with a comment in conf/test_full.config: database_full.csv has no full-size database for them. mi-faser ships its database inside the container rather than as a downloadable release, as DIAMOND and eggNOG-mapper are in beta. We can turn them on once full-size databases are staged on S3.
    • Amended this last point, see comment below.

@vinisalazar

Copy link
Copy Markdown
Collaborator

@jfy133 @nickp60 as said in Slack, just a fix to my last comment about some params being off in the AWS tests: i) I thought the mifaser db was already packaged in the container and that's why it wasn't in databases_full.csv

@vinisalazar
vinisalazar marked this pull request as ready for review September 4, 2026 04:51
@vinisalazar
vinisalazar marked this pull request as draft September 4, 2026 04:51
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.

5 participants