Skip to content

Conversation

@nf-core-bot
Copy link
Member

Version 3.3.1 of nf-core/tools has just been released with updates to the nf-core template. This automated pull-request attempts to apply the relevant updates to this pipeline.

Please make sure to merge this pull-request as soon as possible, resolving any merge conflicts in the nf-core-template-merge-3.3.1 branch (or your own fork, if you prefer). Once complete, make a new minor release of your pipeline.

For instructions on how to merge this PR, please see https://nf-co.re/docs/contributing/sync/.

For more information about this release of nf-core/tools, please see the v3.3.1 release page.

@github-actions
Copy link

github-actions bot commented Jun 3, 2025

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

Posted for pipeline commit 03f0f0a

+| ✅ 279 tests passed       |+
#| ❔   4 tests were ignored |#
!| ❗  20 tests had warnings |!
Details

❗ Test warnings:

  • pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
  • pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline
  • pipeline_todos - TODO string in base.config: Check the defaults for all processes
  • local_component_structure - clonality_classifier.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - cigar_parser.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - alignment_summary.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - find_adapters.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - hitselection.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - venndiagram.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - gpt_prepare_query.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - drugz.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - crisprseq_plotter.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - matricescreation.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - preprocessing_summary.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - orient_reference.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - template_reference.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - extract_umis.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - clustering_summary.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 3.3.1
  • Run at 2025-06-26 08:47:38

@matbonfanti matbonfanti added this to the 3.0.0 milestone Jun 13, 2025
@matbonfanti matbonfanti force-pushed the nf-core-template-merge-3.3.1 branch from 81cfae2 to cbe9bdf Compare June 13, 2025 14:43
@matbonfanti
Copy link

Hi @mirpedrol, I think I fixed the tests as you meant (by loading the specific test profiles from the .nf.test files...
However, if seems that the test 1 (the main_screening test) fails and I cannot find any clear message on why it has failed. Moreover, I tried to run the test on my laptop with the very same test command and it succeed. Any ideas?

@mirpedrol
Copy link
Member

Thanks for taking over, @matbonfanti. I'm having trouble running the tests locally. I am wondering if the seed is correctly applied to the Bagel2 module. Were you able to verify this in your local test runs?

@matbonfanti
Copy link

Hi yes, no problem, I am just about to re-run the tests locally, I tried with codespaces but I was not able to make it work (I have to admite I am quite inexperienced with it). Locally, I always seem to get the same results consistently, but I will do it another time and let you know...

@matbonfanti
Copy link

Hi @mirpedrol ,

It is probably obvious at this point, but however I run the test locally I get always the same consistent md5sum (consistent with the current snapshot). I also checked the BAGEL command lines, when running the test both as a profile and as a nf-test test, and the command line is always:

BAGEL.py bf -i control_vs_treatment.foldchange -o 'control_vs_treatment.bf' -s 3 -e CEGv2.txt -n NEGv1.txt -c control

so it seems that the seed argument is properly injected...

I would like to actually compare the non-matching files, but I am not able to reproduce them in any way. Do you think you can give it a try with a codespaces instance?

@mirpedrol
Copy link
Member

I have tried to run the tests on Gitpod and they pass there. I will try to modify the GitHub action to upload the output files and be able to inspect them.

@mirpedrol
Copy link
Member

Needs some polishing as the upload of the artifact is failing some times, but we can already see the files for one of the failing tests.
From this test, following the download artifact link, which you can allwais find at the end of the "Run nf-test" section, will download the output directory of the test.

@matbonfanti
Copy link

great, thanks! I will check the output files and let you know...

@matbonfanti
Copy link

It looks like the difference comes from rows with identical log fold change (or another sorting key) being ordered differently.

To avoid similar issues in the future, I suggest I take some time to trace the code generating these files and see if I can enforce a consistent and stable row ordering.

I am very busy now. If you do not mind, I can give this a try next week.

@mirpedrol
Copy link
Member

Good investigation work! 🔍
Sounds good 👍 we can wait until next week. Let me know if you need any more help from my side :)

…sprseq into nf-core-template-merge-3.3.1

* 'nf-core-template-merge-3.3.1' of github.com:nf-core/crisprseq:
  pass NXF_VER as input to use it for artifact name
  use github.run_id for artifact name
  add NF veresion to artifact name
  fix artifact path
  update glob pattern
  upload nf-test output as artifact
  skip  modules and subworkflows nf-tests
@matbonfanti
Copy link

Hi @mirpedrol,
I’ve fixed the row ordering issues, those should now be consistent.

However, the drugz results still show small numerical differences, for example:

58c58
< GTF3C1        -3.55   1       -1.97   0.0247  57      0.921   0.975   3420    0.99
---
> GTF3C1        -3.55   1       -1.96   0.0247  57      0.921   0.975   3420    0.99

This appears to be caused by some floating-point instability in the underlying arithmetic.

IMHO, debugging this in detail might require substantial effort and is likely beyond the scope of standard pipeline maintenance.
If you agree, I propose we add the affected files to .nftignore and skip the md5sum check for this specific output.

Let me know your thoughts.

@mirpedrol
Copy link
Member

that's great! Sounds good, I agree it's better to ignore md5 for unstable files and only check the presence of the file

@matbonfanti
Copy link

finally! seems that we can finally merge the code...

Do you think we can keep the changes that you made for keeping the test outputs as artifacts? it may come in handy in the future ;-)

Copy link
Member

@mirpedrol mirpedrol left a comment

Choose a reason for hiding this comment

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

Yes, we should keep them! Let's add a comment to take it into account on future template merges, because I think this will generate merge conflicts in the future

echo "| ⚠️ | No test results found | ${{ inputs.profile }} | ${{ inputs.shard }}/${{ inputs.total_shards }} |" >> $GITHUB_STEP_SUMMARY
fi
- name: Upload nf-test output directory
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- name: Upload nf-test output directory
# Keep this code when resolving merge conflicts. Was added for debugging of nf-test
- name: Upload nf-test output directory

Choose a reason for hiding this comment

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

ops, I did not realize that I had to add the comment before merging, I thought it was already commited... my bad, I will add the comment directly to the dev branch

@matbonfanti matbonfanti merged commit c34655b into dev Jun 26, 2025
39 of 41 checks passed
@matbonfanti matbonfanti deleted the nf-core-template-merge-3.3.1 branch June 26, 2025 10:10
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.

4 participants