Skip to content

fix: address remaining PR #176 review comments - #187

Merged
ljwharbers merged 1 commit into
worktree-lrsomatic-report-modulefrom
fix/pr176-review-nits
Sep 2, 2026
Merged

fix: address remaining PR #176 review comments#187
ljwharbers merged 1 commit into
worktree-lrsomatic-report-modulefrom
fix/pr176-review-nits

Conversation

@ljwharbers

Copy link
Copy Markdown
Collaborator

Summary

Closes out the two review threads on #176 that still pointed at something real in the code. Everything else open on that PR was either already fixed (the threads just never got resolved) or factually wrong — see the audit note posted on #176.

  • README.md:107 — "a multiqc report from that combines the output from mosdepth and samtools into one html report" → drops the stray "from" and capitalises HTML. Flagged three times on Add LRSOMATICREPORT as the final pipeline step #176 (r3880745421, plus twice as a suppressed comment).
  • modules/local/lrsomaticreport/main.nf — quote the interpolated paths in the script block (r3880745383). The Rscript invocation passed report_src, the sample id, the sex and the output filename unquoted, so a projectDir or sample id containing a space would word-split; the flat-input symlink loop had the same shape.

${args} deliberately stays unquoted — it is a pre-built argument string, and each --gene-panel value is already quoted where it is assembled in conf/modules.config.

Test plan

  • nextflow lint modules/local/lrsomaticreport/main.nf — clean
  • pre-commit run --files README.md modules/local/lrsomaticreport/main.nf — clean
  • nf-test test modules/local/lrsomaticreport/tests/main.nf.test --profile singularity — all 4 tests pass (stub, real render, gene-panel render, multi-panel render), no snapshot changes

The real-render test asserts the rendered HTML contains TP53, which can only get there through the link_flat symlink loop, so the quoted loop is verified end to end rather than just parsed.

🤖 Generated with Claude Code

Two nits from the Copilot review threads on #176 that were still real:

- README: "a `multiqc` report from that combines" dropped the stray "from",
  and "one html report" -> "one HTML report".
- LRSOMATICREPORT: quote the interpolated paths in the script block. The
  `Rscript` invocation passed report_src, the sample id, the sex and the
  output filename unquoted, so a projectDir or sample id containing a space
  would word-split; the flat-input symlink loop had the same shape. ${args}
  stays unquoted -- it is a pre-built argument string that already quotes
  each `--gene-panel` value in conf/modules.config.

No output or version changes, so no snapshots move.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown

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

Posted for pipeline commit cdd98db

+| ✅ 201 tests passed       |+
#| ❔  23 tests were ignored |#
#| ❔   1 tests had warnings |#
!| ❗  38 tests had warnings |!
Details

❗ Test warnings:

  • nextflow_config - Config manifest.version should end in dev: 1.1.0
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in README.md: Include a figure that guides the user through the major workflow steps. Many nf-core
  • pipeline_todos - TODO string in nextflow.config: Specify your pipeline's command line flags
  • pipeline_todos - TODO string in nextflow.config: Update the field with the details of the contributors to your pipeline. New with Nextflow version 24.10.0
  • pipeline_todos - TODO string in meta.yml: #Add a description of the module and list keywords
  • pipeline_todos - TODO string in nextflow.config: Specify any additional parameters here
  • 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 CONTRIBUTING.md: Add any pipeline specific contribution guidelines here, such as coding styles, procedures, checklists etc.
  • pipeline_todos - TODO string in base.config: Check the defaults for all processes
  • pipeline_todos - TODO string in base.config: Customise requirements for specific processes.
  • schema_description - Ungrouped param in schema: skip_modkit
  • schema_description - No description provided in schema for parameter: generate_gvcf
  • schema_description - No description provided in schema for parameter: autocorrelation
  • schema_description - No description provided in schema for parameter: vep_custom
  • schema_description - No description provided in schema for parameter: vep_custom_tbi
  • schema_description - No description provided in schema for parameter: severus_minsupport
  • schema_description - No description provided in schema for parameter: wakhan_chroms
  • local_component_structure - phasing_haplotyping.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - small_variant_consensus.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - prepare_reference_files.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - prepare_annotation.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - deepsomatic.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure

❔ Tests ignored:

  • files_exist - File is ignored: CODE_OF_CONDUCT.md
  • files_exist - File is ignored: assets/nf-core-lrsomatic_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-lrsomatic_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-lrsomatic_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
  • files_exist - File is ignored: .github/CONTRIBUTING.md
  • nextflow_config - Config variable ignored: manifest.name
  • nextflow_config - Config variable ignored: manifest.homePage
  • files_unchanged - File ignored due to lint config: .gitattributes
  • files_unchanged - File ignored due to lint config: CODE_OF_CONDUCT.md
  • files_unchanged - File ignored due to lint config: .github/ISSUE_TEMPLATE/bug_report.yml
  • 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_comment.yml
  • files_unchanged - File ignored due to lint config: .github/workflows/linting.yml
  • files_unchanged - File ignored due to lint config: assets/email_template.txt
  • files_unchanged - File ignored due to lint config: assets/nf-core-lrsomatic_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-lrsomatic_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-lrsomatic_logo_dark.png
  • files_unchanged - File ignored due to lint config: docs/README.md
  • actions_awstest - 'awstest.yml' workflow not found: /home/runner/work/lrsomatic/lrsomatic/.github/workflows/awstest.yml

❔ Tests fixed:

✅ Tests passed:

Run details

  • nf-core/tools version 4.0.2
  • Run at 2026-09-02 09:30:58

@ljwharbers
ljwharbers merged commit 3d454bf into worktree-lrsomatic-report-module Sep 2, 2026
4 of 6 checks passed
@ljwharbers
ljwharbers deleted the fix/pr176-review-nits branch September 2, 2026 09:32
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.

1 participant