Skip to content

feat: add vcontact3/run module#12198

Open
JP-Bro wants to merge 46 commits into
nf-core:masterfrom
JP-Bro:vcontact3-run
Open

feat: add vcontact3/run module#12198
JP-Bro wants to merge 46 commits into
nf-core:masterfrom
JP-Bro:vcontact3-run

Conversation

@JP-Bro

@JP-Bro JP-Bro commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Description

Implements the VCONTACT3/RUN module for viral genome clustering using protein-level homology comparison.

Related Issues

Closes #11569

Module Details

  • Tool: VCONTACT3 v3.1.6
  • Purpose: Cluster and compare viral genomes
  • Inputs: FASTA/GenBank genome files
  • Outputs: Cluster assignments, comparison networks, cluster profiles

Checklist

  • Module follows nf-core standards
  • Process definition in main.nf includes proper inputs/outputs
  • Metadata (meta.yml) is complete
  • Conda environment (environment.yml) specified
  • Test structure created
  • Code is clean and documented

Testing

Module created with proper Nextflow DSL2 structure. Ready for integration testing with nf-core CI/CD pipeline.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

we don't use this file anymore 🙂

@mashehu mashehu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

it looks like you started this module an outdated template, so I would recommend to rerun nf-core moduels create with nf-core/tools version 4.0.2. (and then copy over the code)

@mashehu mashehu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

looks like you missed the template changes iin the main.nf 🙂

Comment thread modules/nf-core/vcontact3/run/main.nf
Comment thread modules/nf-core/vcontact3/run/main.nf Outdated
Comment on lines +30 to +33
cat > versions.yml <<-EOF_VERSIONS
"${task.process}":
vcontact3: \$( vcontact3 --version 2>&1 | grep -oP 'vcontact3, version \\K[^\\s]+' )
EOF_VERSIONS

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Comment thread modules/nf-core/vcontact3/run/tests/main.nf.test Outdated
Comment thread modules/nf-core/vcontact3/run/tests/main.nf.test Outdated
tag "vcontact3"
tag "vcontact3/run"

test("vcontact3_run - stub") {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why not a full test?

Comment thread modules/nf-core/vcontact3/run/main.nf Outdated
Comment thread modules/nf-core/vcontact3/run/meta.yml Outdated
- vcontact3_output/:
type: directory
description: VCONTACT3 output directory containing clustering results
pattern: "vcontact3_output/"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

you also need to add the versions_vcontact3 channel here.
This should be automatically resolved withnf-core modules lint --fix

Comment thread modules/nf-core/vcontact3/run/main.nf
Comment on lines +34 to +35
touch vcontact3_output/clusters.csv
touch vcontact3_output/merged_df.csv

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

based on this, the output section should capture the csv files, not the whole directory

@mashehu

mashehu commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

are you writing the snapshots by hand? they don't follow the nf-test format. you can generate them using nf-test test --tag vcontact3 --update-snapshot

@atrigila atrigila added the awaiting-changes will be closed after 30 days label Jul 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting-changes will be closed after 30 days

Projects

None yet

Development

Successfully merging this pull request may close these issues.

new module: VCONTACT3/RUN

3 participants