Skip to content

Important! Template update for nf-core/tools v3.4.1 #299

Merged
chris-cheshire merged 37 commits intodevfrom
nf-core-template-merge-3.4.1
Nov 18, 2025
Merged

Important! Template update for nf-core/tools v3.4.1 #299
chris-cheshire merged 37 commits intodevfrom
nf-core-template-merge-3.4.1

Conversation

@maxulysse
Copy link
Member

@maxulysse maxulysse commented Oct 21, 2025

Replaces:

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/cutandrun branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core 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).

nf-core-bot and others added 30 commits December 19, 2023 19:03
I removed the merge marker comments after adding the pipeline specific default params and allowing for pipeline-specific custom profiles
Updated nf-core/cutandrun main.nf to comply with template version 3.3.1
@maxulysse maxulysse changed the base branch from master to dev October 21, 2025 12:03
@github-actions
Copy link

github-actions bot commented Oct 21, 2025

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

Posted for pipeline commit ce036e0

+| ✅ 306 tests passed       |+
!| ❗  39 tests had warnings |!
Details

❗ Test warnings:

  • 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 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 nextflow.config: Specify any additional parameters here
  • schema_description - No description provided in schema for parameter: run_genome_prep
  • schema_description - No description provided in schema for parameter: run_cat_fastq
  • schema_description - No description provided in schema for parameter: run_trim_galore_fastqc
  • schema_description - No description provided in schema for parameter: run_alignment
  • schema_description - No description provided in schema for parameter: run_read_filter
  • schema_description - No description provided in schema for parameter: run_preseq
  • schema_description - No description provided in schema for parameter: run_mark_dups
  • schema_description - No description provided in schema for parameter: run_remove_dups
  • schema_description - No description provided in schema for parameter: run_remove_linear_dups
  • schema_description - No description provided in schema for parameter: run_peak_calling
  • schema_description - No description provided in schema for parameter: run_consensus_all
  • schema_description - No description provided in schema for parameter: run_reporting
  • schema_description - No description provided in schema for parameter: run_deeptools_heatmaps
  • schema_description - No description provided in schema for parameter: run_deeptools_qc
  • schema_description - No description provided in schema for parameter: run_peak_qc
  • schema_description - No description provided in schema for parameter: run_multiqc
  • schema_description - No description provided in schema for parameter: run_igv
  • schema_description - No description provided in schema for parameter: fragment_size
  • local_component_structure - gtf2bed.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - peak_counts.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - samtools_custom_view.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - peak_frip.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - consensus_peaks.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - fastqc_trimgalore.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - extract_fragments.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - prepare_genome.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - peak_qc.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - mark_duplicates_picard.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - extract_metadata_awk.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - prepare_peakcalling.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - samtools_view_sort_stats.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - deeptools_qc.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - align_bowtie2.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - deduplicate_linear.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure

✅ Tests passed:

Run details

  • nf-core/tools version 3.4.1
  • Run at 2025-10-21 12:45:54

@nf-core nf-core deleted a comment from github-actions bot Oct 21, 2025
Copy link
Member

@pinin4fjords pinin4fjords left a comment

Choose a reason for hiding this comment

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

You are the master of these things, nobody I trust more.

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.

Very nice work @maxulysse! This will be very useful 🥳
I have left some comments mainly regarding nf-test, I am a bit confused with what is done in this PR or what should be done in the future.
But overall looks very good!

Copy link
Member

Choose a reason for hiding this comment

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

should we keep this file until nf-test tests are implemented in the pipeline?

Copy link
Member Author

Choose a reason for hiding this comment

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

I assumed tests are failing since I only restored partial functionality from the old check samplesheet script.
I'd rather we don't try to make this ci work, and try migrating the tests to nf-test directly

Copy link
Member

Choose a reason for hiding this comment

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

mostly for our future selves, have this resource configurations been moved somewhere else?

Copy link
Member Author

Choose a reason for hiding this comment

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

yes, I moved all in base, I believe that's where it should sit

Copy link
Member

Choose a reason for hiding this comment

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

are the tests removed because nf-test is not implemented yet? should we keep them anyway if they don't break anything?

Copy link
Member Author

Choose a reason for hiding this comment

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

these are coming from the modules repo, so no need to retest them in the pipeline

main:

def caller_list = ['seacr', 'macs2']
callers = params.peakcaller ? params.peakcaller.split(',').collect { it.trim().toLowerCase() } : ['seacr']
Copy link
Member

Choose a reason for hiding this comment

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

I see you moved defining callers here! So my previous comment about params.callers is outdated, but I think params.callers should be removed from modules.config

Copy link
Member Author

Choose a reason for hiding this comment

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

Agreeing with you, but I tried to limit my changes in this single PR

@chris-cheshire chris-cheshire merged commit 7bc16f0 into dev Nov 18, 2025
11 checks passed
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.

6 participants

Comments