Skip to content

Window size#52

Merged
muffato merged 4 commits into
devfrom
window_size
May 28, 2026
Merged

Window size#52
muffato merged 4 commits into
devfrom
window_size

Conversation

@muffato
Copy link
Copy Markdown
Member

@muffato muffato commented May 28, 2026

Now that we have a 26.04-compatible way of making the output name, cf sanger-tol/readmapping#244, here is its application to this pipeline.

No need to provide .1k as a string, it can be automatically inferred from an actual integer

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
  • 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).

@muffato muffato requested a review from sainsachiko May 28, 2026 08:22
@muffato muffato self-assigned this May 28, 2026
Copilot AI review requested due to automatic review settings May 28, 2026 08:22
@sanger-tolsoft
Copy link
Copy Markdown
Contributor

Warning

Newer version of the nf-core template is available.

Your pipeline is using an old version of the nf-core template: 3.5.2.
Please update your pipeline to the latest version.

For more documentation on how to update your pipeline, please see the nf-core documentation and Synchronisation documentation.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 28, 2026

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

Posted for pipeline commit 7515d04

+| ✅ 169 tests passed       |+
#| ❔  25 tests were ignored |#
!| ❗   6 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 nextflow.config: Specify any additional parameters here
  • local_component_structure - fasta_windows.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - params_check.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure

❔ Tests ignored:

  • files_exist - File is ignored: assets/multiqc_config.yml
  • files_exist - File is ignored: assets/nf-core-sequencecomposition_logo_light.png
  • files_exist - File is ignored: conf/igenomes.config
  • files_exist - File is ignored: conf/igenomes_ignored.config
  • files_exist - File is ignored: docs/images/nf-core-sequencecomposition_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-sequencecomposition_logo_dark.png
  • files_exist - File is ignored: .github/ISSUE_TEMPLATE/config.yml
  • files_exist - File is ignored: .github/workflows/awstest.yml
  • files_exist - File is ignored: .github/workflows/awsfulltest.yml
  • nextflow_config - Config variable ignored: manifest.name
  • nextflow_config - Config variable ignored: manifest.homePage
  • nextflow_config - Config default ignored: params.selected_fw_output
  • files_unchanged - File ignored due to lint config: .gitattributes
  • files_unchanged - File ignored due to lint config: LICENSE or LICENSE.md or LICENCE or LICENCE.md
  • files_unchanged - File ignored due to lint config: .github/CONTRIBUTING.md
  • files_unchanged - File ignored due to lint config: .github/ISSUE_TEMPLATE/bug_report.yml
  • files_unchanged - File does not exist: .github/ISSUE_TEMPLATE/config.yml
  • files_unchanged - File ignored due to lint config: .github/PULL_REQUEST_TEMPLATE.md
  • files_unchanged - File ignored due to lint config: .github/workflows/linting.yml
  • files_unchanged - File ignored due to lint config: assets/sendmail_template.txt
  • files_unchanged - File does not exist: assets/nf-core-sequencecomposition_logo_light.png
  • files_unchanged - File does not exist: docs/images/nf-core-sequencecomposition_logo_light.png
  • files_unchanged - File does not exist: docs/images/nf-core-sequencecomposition_logo_dark.png
  • actions_awstest - 'awstest.yml' workflow not found: /home/runner/work/sequencecomposition/sequencecomposition/.github/workflows/awstest.yml
  • multiqc_config - multiqc_config

✅ Tests passed:

Run details

  • nf-core/tools version 3.5.2
  • Run at 2026-05-28 08:55:04

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR replaces the previous output-naming-only window_size_info parameter with a real window_size integer parameter, wiring it into the FASTAWINDOWS execution and using it to derive consistent output filename labels. It also tightens validation for the selected_fw_output parameter via the Nextflow schema.

Changes:

  • Remove window_size_info from the FASTA_WINDOWS subworkflow interface and associated meta.id construction.
  • Add params.window_size (default 1000) and validate it in nextflow_schema.json; use it to set FASTAWINDOWS args and to derive published output prefixes.
  • Improve selected_fw_output schema validation (file-path + exists) and document parameter changes in the changelog.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
workflows/sequencecomposition.nf Updates the FASTA_WINDOWS call to match the new interface (drops window_size_info).
subworkflows/local/fasta_windows.nf Stops appending window_size_info to meta.id when constructing downstream IDs.
nextflow.config Removes window_size_info, introduces window_size with a default value.
nextflow_schema.json Replaces window_size_info with typed window_size; adds stronger validation for selected_fw_output.
conf/modules.config Passes window size to FASTAWINDOWS and derives output prefixes (e.g., 1k, 500bp) for BGZIPTABIX.
CHANGELOG.md Documents the new parameter and deprecation of window_size_info.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md Outdated
Copy link
Copy Markdown

@sainsachiko sainsachiko left a comment

Choose a reason for hiding this comment

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

LGTM!

Copilot AI review requested due to automatic review settings May 28, 2026 08:52
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

@muffato muffato merged commit 8371f90 into dev May 28, 2026
9 checks passed
@muffato muffato deleted the window_size branch May 28, 2026 09:00
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