Skip to content

feat(vcontact3): add vcontact3/prepareddatabases module#11738

Draft
olawal1001 wants to merge 12 commits into
nf-core:masterfrom
olawal1001:master
Draft

feat(vcontact3): add vcontact3/prepareddatabases module#11738
olawal1001 wants to merge 12 commits into
nf-core:masterfrom
olawal1001:master

Conversation

@olawal1001
Copy link
Copy Markdown

PR checklist

Closes #XXX

  • 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 module conventions in the contribution docs
  • If necessary, include test data in your PR.
  • Remove all TODO statements.
  • Broadcast software version numbers to topic: versions - See version_topics
  • Follow the naming conventions.
  • Follow the parameters requirements.
  • Follow the input/output options guidelines.
  • Add a resource label
  • Use BioConda and BioContainers if possible to fulfil software requirements.
  • Ensure that the test works with either Docker / Singularity. Conda CI tests can be quite flaky:
    • For modules:
      • nf-core modules test <MODULE> --profile docker
      • nf-core modules test <MODULE> --profile singularity
      • nf-core modules test <MODULE> --profile conda
    • For subworkflows:
      • nf-core subworkflows test <SUBWORKFLOW> --profile docker
      • nf-core subworkflows test <SUBWORKFLOW> --profile singularity
      • nf-core subworkflows test <SUBWORKFLOW> --profile conda

@olawal1001 olawal1001 requested review from a team as code owners May 21, 2026 15:28
Copy link
Copy Markdown
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

Good first start @olawal1001 !

Comments below :) Main thing is the meta.yaml documentation file has not yet been updated.

Comment thread nf-core/vcontact3/prepareddatabases/environment.yml Outdated
Comment thread nf-core/vcontact3/prepareddatabases/main.nf Outdated
Comment thread nf-core/vcontact3/prepareddatabases/main.nf Outdated
Comment thread nf-core/vcontact3/prepareddatabases/main.nf Outdated
Comment thread nf-core/vcontact3/prepareddatabases/main.nf
Comment thread nf-core/vcontact3/prepareddatabases/meta.yml Outdated
Comment thread nf-core/vcontact3/prepareddatabases/meta.yml
@jfy133 jfy133 marked this pull request as draft May 22, 2026 08:19
@jfy133
Copy link
Copy Markdown
Member

jfy133 commented Jun 2, 2026

@olawal1001 please join the nf-core GitHub organisation (instructions: https://nf-co.re/join) so you don't have to wait for someone to approve execution of tests :)

Copy link
Copy Markdown
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

Getting closer! @olawal1001 !

Comment on lines +28 to +29
def meta = process.out.database.get(0).get(0)
def dbDir = process.out.database.get(0).get(1)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

You don't need these as variables, you can specify the process.out.database directly in the path() call on line 33.

You also can drop the testing of the meta, just the directory would be sufficient here.

Comment on lines +29 to +32
cat <<EOF > versions.yml
"${task.process}":
vcontact3: 3.1.6
EOF
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This still needs to be removed/replaced with the new system! Why did you resolve the previous commnet?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

I did replace it but I don't think it committed successfully.. I check again

- clustering
- vcontact3
tools:
## TODO nf-core: Add a description and other details for the software below
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

All of these TODOs in this file need to be removed

Comment thread nf-core/vcontact3/prepareddatabases/main.nf Outdated
Comment thread nf-core/vcontact3/prepareddatabases/main.nf Outdated
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
@jfy133
Copy link
Copy Markdown
Member

jfy133 commented Jun 2, 2026

The test failure seems to imply that the vcontact container is missing curl as a dependency... I think this would require a bioconda recipe update to include the missing tool in the environment

@olawal1001
Copy link
Copy Markdown
Author

@olawal1001 please join the nf-core GitHub organisation (instructions: https://nf-co.re/join) so you don't have to wait for someone to approve execution of tests :)

joined@jfy133

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.

2 participants