Skip to content

Added functional meta.yml and test #91

Open
Muskan-2464 wants to merge 25 commits intodevfrom
add-functional-meta-and-test-2
Open

Added functional meta.yml and test #91
Muskan-2464 wants to merge 25 commits intodevfrom
add-functional-meta-and-test-2

Conversation

@Muskan-2464
Copy link

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
  • If necessary, also make a PR on the nf-core/proteinannotator branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (e.g. nf-test test */local --profile=~test,docker for all new local tests).
  • Check for unexpected warnings in debug mode (nf-test test */local --profile=~test,docker,debug).
  • 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).

@nf-core-bot
Copy link
Member

Warning

Newer version of the nf-core template is available.

Your pipeline is using an old version of the nf-core template: 3.5.1.
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.

@Muskan-2464 Muskan-2464 marked this pull request as ready for review March 13, 2026 18:52
Copy link
Collaborator

@vagkaratzas vagkaratzas left a comment

Choose a reason for hiding this comment

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

Left comments to revise. In addition:

  1. when staging files, and before commiting them, run pre-commit locally so formatting issues are tackled there
  2. make sure nf-core subworkflows lint command passes all test for this subworkflow
  3. Run the nf-test test /path/to/test/main.nf.test --profile +singularity --verbose command twice; one to generate the snapshot, and then once more to make sure the snapshot is not changing.


authors:
- "@vagkaratzas"
- "@Muskan-2464
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- "@Muskan-2464
- "@Muskan-2464"

Comment on lines +34 to +35
description: TSV file containing InterProScan functional annotation results.
Structure: [ val(meta), path(tsv) ]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
description: TSV file containing InterProScan functional annotation results.
Structure: [ val(meta), path(tsv) ]
description: |
TSV file containing InterProScan functional annotation results.
Structure: [ val(meta), path(tsv) ]

Structure must be part of the description

Comment on lines +39 to +40
description: File containing software versions for all tools used in the workflow.
Structure: [ path(versions.yml) ]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
description: File containing software versions for all tools used in the workflow.
Structure: [ path(versions.yml) ]
description: |
File containing software versions for all tools used in the workflow.
Structure: [ path(versions.yml) ]

@@ -0,0 +1,47 @@
name: functional_annotation
description: Performs functional annotation of protien sequences
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
description: Performs functional annotation of protien sequences
description: Performs functional annotation of protein sequences

when {
workflow {
"""
input[0] = Channel.of([
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
input[0] = Channel.of([
input[0] = channel.of([

new strict syntax

Comment on lines +10 to +12
// -------------------------------------------------------
// TEST 1: Skip InterProScan (safest for CI, no DB needed)
// -------------------------------------------------------
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
// -------------------------------------------------------
// TEST 1: Skip InterProScan (safest for CI, no DB needed)
// -------------------------------------------------------

// -------------------------------------------------------
// TEST 1: Skip InterProScan (safest for CI, no DB needed)
// -------------------------------------------------------
test("fasta - skip_interproscan true") {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
test("fasta - skip_interproscan true") {
test("faa - functional annotation) {

Comment on lines +31 to +34
assertAll(
{ assert workflow.success },
{ assert workflow.out.interproscan_tsv == [] },
{ assert snapshot(workflow.out.versions).match("versions_skip") }
Copy link
Collaborator

Choose a reason for hiding this comment

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

Update this block to mathc the new test. CHeck the nf-test of domain annotation local subworkflow for inspiration

// -------------------------------------------------------
// TEST 2: Stub run with skip=false (no real DB download)
// -------------------------------------------------------
test("stub run - skip interproscan") {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Either remove this second test, or run it with skip_interproscan true, but dont name it stub. (we already have a stub one after)

Comment on lines +92 to +96
assertAll(
{ assert workflow.success },
{ assert workflow.out.interproscan_tsv == [] },
{ assert workflow.out.versions == [] }
)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Update the assertion to more nf-core like ones; see the other local subworkflows of the pipeline

@@ -0,0 +1,99 @@
nextflow_workflow {

name "Test Workflow FUNCTIONAL_ANNOTATION"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
name "Test Workflow FUNCTIONAL_ANNOTATION"
name "Test Subworkflow FUNCTIONAL_ANNOTATION"

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