Skip to content

Release 1.0.0 (dev branch) - #52

Open
vinisalazar wants to merge 356 commits into
mainfrom
dev
Open

vinisalazar wants to merge 356 commits into
mainfrom
dev

Conversation

@vinisalazar

@vinisalazar vinisalazar commented Apr 28, 2026

Copy link
Copy Markdown
Collaborator

Investigating RGI test problem

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 you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/funcprofiler branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

vinisalazar added a commit to vinisalazar/funcprofiler that referenced this pull request Aug 5, 2026
The default test disabled FASTQC with ext.when = false, so docs/output.md
advertised a fastqc/ directory that the snapshot never contained, which is what
jonasscheid flagged on nf-core#52. tests/.nftignore already carried the rule to ignore
FastQC report contents, so dropping the gate records the paths without making
the snapshot depend on unstable file contents. Runtime goes from ~170s to ~366s.

Also add the database versions note jfy133 asked for: the pipeline passes
db_path straight through and never checks it against the tool version, plus the
tool/database combinations exercised on the pilot cohort.
vinisalazar and others added 13 commits August 11, 2026 13:08
FastQC was never called, so the citation claimed a tool that never ran.
Also carries over the database version table from #76.
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.
Important! Template update for nf-core/tools v4.1.0

@jonasscheid jonasscheid left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well done from my side 👍🏼

@jfy133 jfy133 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be merged (and released following the release procedure!), once the last two things have been addressed:

  1. Mifaser activated within test_full.config and is working
  2. The last input validation moved I mentioned on Slack

The other points on my Slack message are recommended but optional, so I won't block release based on those.

Congratulations on getting the first version (hopefully of many!) pipeline completed! This has not been a trivial set of tools or databases to get together, and it's been great seeing the cross-institutional teamwork forming 💪️

@vinisalazar

Copy link
Copy Markdown
Collaborator Author

Thanks a lot for your amazing effort and support @jfy133 !

  1. Addressing now.
  2. I understand this one is addressed by 59059c4?

@vinisalazar

Copy link
Copy Markdown
Collaborator Author

@nickp60 would you do the honours of merging? 😄

@nickp60

nickp60 commented Sep 14, 2026

Copy link
Copy Markdown
Collaborator

Just working on fixing aws test databases, then yes!

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.

7 participants