Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update modules #449

Merged
merged 8 commits into from
Nov 24, 2023
Merged

Conversation

ramprasadn
Copy link
Collaborator

PR checklist

This PR updates two modules (eklipse & svdb query) and introduces along relevant changes in the pipeline.

  • 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/raredisease branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Ensure the test suite passes (nextflow run . -profile test_one_sample,docker --outdir <OUTDIR>).
  • 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).

Copy link

github-actions bot commented Nov 23, 2023

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit ec49262

+| ✅ 151 tests passed       |+
#| ❔   6 tests were ignored |#
!| ❗   2 tests had warnings |!

❗ Test warnings:

  • pipeline_todos - TODO string in WorkflowRaredisease.groovy: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required

❔ Tests ignored:

  • files_exist - File is ignored: conf/modules.config
  • files_unchanged - File ignored due to lint config: .github/PULL_REQUEST_TEMPLATE.md
  • files_unchanged - File ignored due to lint config: .github/workflows/linting.yml
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-raredisease_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-raredisease_logo_dark.png
  • files_unchanged - File ignored due to lint config: .gitignore or .prettierignore or pyproject.toml

✅ Tests passed:

Run details

  • nf-core/tools version 2.10
  • Run at 2023-11-24 12:55:01

@ramprasadn ramprasadn marked this pull request as ready for review November 23, 2023 13:19
Copy link
Collaborator

@jemten jemten left a comment

Choose a reason for hiding this comment

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

Looks good, just a comment about the names of the channel branches. It took me a couple of minutes to figure out which branch was what. Or maybe that is as easy as it will get. Also, the svdb_query prefix which should not cause any issues for now but is a potential headache.

@@ -13,7 +13,8 @@ process SVDB_QUERY {
val(in_frqs)
val(out_occs)
val(out_frqs)
path (vcf_dbs)
path(vcf_dbs)
path(bedpe_dbs)

output:
tuple val(meta), path("*_query.vcf") , emit: vcf
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just realising that this module is dependent on the user/developer setting ext.prefixto something like `${meta.id}_svdbquery. Failing to do this it won't work. Either the module needs to be hardcoded to add that prefix or the output needs to change to use ${prefix}.vcf. Or have I missed something?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

docs/usage.md Outdated Show resolved Hide resolved
subworkflows/local/annotate_structural_variants.nf Outdated Show resolved Hide resolved
subworkflows/local/annotate_structural_variants.nf Outdated Show resolved Hide resolved
ramprasadn and others added 2 commits November 23, 2023 17:04
Co-authored-by: Anders Jemt <jemten@users.noreply.github.com>
Copy link
Contributor

@Lucpen Lucpen left a comment

Choose a reason for hiding this comment

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

Looks good, I will need to look into the new module tests

@@ -4,7 +4,7 @@ process EKLIPSE {
label 'process_single'

// WARN: Version information not provided by tool on CLI. Please update this string when bumping container versions.
conda "bioconda::eklipse=1.8"
conda "${moduleDir}/environment.yml"
Copy link
Contributor

Choose a reason for hiding this comment

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

Very nice, now the environment is directly there. Is it like that for all the new modules?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yupe.. with nf-tests every tool and subtool will come as a unit containing scripts, tests, and the environment :)

Copy link
Collaborator

@jemten jemten left a comment

Choose a reason for hiding this comment

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

Looks good! Could you just check that SVDB_query works as intended when you run both a vcf and bedpe database. Right now they will have the same suffix and I don't know which file be selected to the emit channel. Go ahead and merge when you feel confident in the code

@ramprasadn ramprasadn merged commit 8f98b84 into nf-core:dev Nov 24, 2023
8 checks passed
@ramprasadn ramprasadn deleted the smallupdates branch November 24, 2023 13:11
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.

None yet

3 participants