Skip to content

fix(pridepy): drop output/ subdir, write to workDir#33

Merged
ypriverol merged 1 commit intobigbio:devfrom
Shen-YuFei:dev
Apr 28, 2026
Merged

fix(pridepy): drop output/ subdir, write to workDir#33
ypriverol merged 1 commit intobigbio:devfrom
Shen-YuFei:dev

Conversation

@Shen-YuFei
Copy link
Copy Markdown
Contributor

Pull Request

Description

Address review on #31: mkdir -p output and cd output are unnecessary because Nextflow already runs each task in its own workDir; the explicit output/ subdirectory wraps the tool call in dead weight. Switch the module to write outputs directly to the workDir and let downstream pipelines glob via modules.config.

  • main.nf
    • Drop mkdir -p output + cd output wrapper from script; pridepy now writes to the workDir root.
    • Replace tuple val(meta), path(output/) with two emit channels matching nf-modules style (cf. THERMORAWFILEPARSER):
      • spectra*.{raw,mzML,mzML.gz,mgf,d.tar,d.tar.gz,d.zip,dia,wiff,wiff.scan}, optional: true
      • checksums*-checksum.tsv, optional: true
    • Stub now gates -checksum.tsv creation on --checksum-check in task.ext.args so stub behaviour matches production.
  • meta.yml: sync output schema (download_dir -> spectra + checksums).
  • tests/main.nf.test + tests/nextflow.config: expand stub coverage to two cases (no checksum / with --checksum-check); assertions cover spectra / checksums / versions size and snapshots.

Verified locally:

nf-test test modules/bigbio/pridepy/tests/main.nf.test
Test [aa2c172f] 'Should run stub mode (no checksum)' PASSED (6.925s)
Test [c50bb176] 'Should run stub mode with --checksum-check' PASSED (6.211s)
SUCCESS: Executed 2 tests in 13.219s

Downstream consumers (quantms, quantmsdiann) will need to drop -o output from task.ext.args and switch from the download_dir directory channel to the spectra file channel.

Checklist

  • Module follows nf-core standards
  • main.nf includes process definition
  • meta.yml includes complete documentation
  • environment.yml specifies dependencies
  • Tests are included
  • Code is formatted (prettier)
  • CI checks pass

Module Type

  • New module
  • Module update
  • Bug fix
  • Documentation

Related Issues

Refs #31

Copilot AI review requested due to automatic review settings April 28, 2026 10:19
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 28, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 60e81399-bf80-440e-80f0-d12d1e49cdbf

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codacy-production
Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@Shen-YuFei Shen-YuFei closed this Apr 28, 2026
@Shen-YuFei Shen-YuFei reopened this Apr 28, 2026
Copy link
Copy Markdown
Contributor

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

Updates the bigbio/pridepy Nextflow module to write outputs directly into the task work directory (instead of an output/ subfolder) and aligns emitted outputs and tests with nf-modules conventions.

Changes:

  • Removed the mkdir -p output / cd output wrapper so pridepy writes to the workDir root.
  • Replaced the single download_dir directory output with two optional emitted channels: spectra and checksums.
  • Expanded nf-test coverage to validate stub behavior for both “no checksum” and “with --checksum-check” cases, updating snapshots accordingly.

Reviewed changes

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

Show a summary per file
File Description
modules/bigbio/pridepy/main.nf Drops output/ subdir usage; emits spectra + checksums (optional) and updates stub to conditionally create checksum output.
modules/bigbio/pridepy/meta.yml Syncs output schema/documentation from download_dir to spectra + checksums.
modules/bigbio/pridepy/tests/nextflow.config Adds withName: PRIDEPY_DOWNLOAD to pass module args via ext.args from test params.
modules/bigbio/pridepy/tests/main.nf.test Adds two stub-mode tests and asserts channel sizes + snapshots for spectra/checksums/versions.
modules/bigbio/pridepy/tests/main.nf.test.snap Updates snapshots to match new emitted channels and stub outputs.

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

@ypriverol ypriverol merged commit 49e1cc6 into bigbio:dev Apr 28, 2026
5 of 6 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.

3 participants