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

Release 0.5.0 #581

Merged
merged 100 commits into from
Mar 3, 2025
Merged

Release 0.5.0 #581

merged 100 commits into from
Mar 3, 2025

Conversation

fellen31
Copy link
Collaborator

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
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,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).

fellen31 and others added 30 commits January 16, 2025 09:15
* Add missing credits

* update changelog
* Assemble ONT genomes

* hifiasm 0.24.0

* update tests

* update patch
* Initial template commit

* Template update for nf-core/tools version 3.1.2.dev0

* Template update for nf-core/tools version 3.1.1

* changelog

* merge mistake

* merge mistake

* merge mistake

* merge mistakes

* fix lint

* update ci

* fix version

* fix tests

* fix RO crate

* remove nf-core reference
* output per-base depth in d4 format

* Changelog

* update nf-core module
* Downgrade to Sniffles1

* Update CHANGELOG.md

* bump deepvariant version (#535)

* fix readme
* Initial template commit

* Template update for nf-core/tools version 3.1.2.dev0

* Template update for nf-core/tools version 3.1.2.dev0

* Template update for nf-core/tools version 3.1.2.dev0

* Template update for nf-core/tools version 3.1.1

* Template update for nf-core/tools version 3.1.1

* use ro-crate command

* changelog
* Run CI tests with latest-stable version of nextflow

* Changelog
* Fix naming mistakes in output docs

* Changelog and prettier

* Update docs/output.md

Co-authored-by: Anders Jemt <jemten@users.noreply.github.com>

* prettier

---------

Co-authored-by: Anders Jemt <jemten@users.noreply.github.com>
fellen31 and others added 19 commits February 12, 2025 15:49
* Bump Severus version

* Update CHANGELOG.md
* Downgrade to Sniffles1

* Update CHANGELOG.md

* bump deepvariant version (#535)

* Always run multiple SV-callers

* changelog

* changelog

* update tests and ci

* Also output CNV-calls

* CHANGELOG

* update conf

* wip

* update docs+tests

* remove rouge versions.yml
* Initial template commit

* Template update for nf-core/tools version 3.1.2.dev0

* Template update for nf-core/tools version 3.1.1

* Template update for nf-core/tools version None

* Template update for nf-core/tools version None

* CHANGELOG
* Fix pipeline can't run without

* CHANGELOG

* docs

* docs

* update snaps

* fix CI

* Update CHANGELOG.md

* changelog date

* Add vep_plugin_files to files check

* CHANGELOG

* Update CHANGELOG.md

* always failing CI because of nf-core update
* wip

* Replace dipcall

* Replace dipcall

* description

* Update CHANGELOG

* ignore bam md5

* CHANGELOG

* Update main.nf

* Update workflows/nallo.nf

Co-authored-by: Anders Jemt <jemten@users.noreply.github.com>

---------

Co-authored-by: Anders Jemt <jemten@users.noreply.github.com>
* Fix filter SNVs tries to run even with --skip_snv_calling

* CHANGELOG

* Update CHANGELOG.md
* Fix unsorted sniffles1 variants

* update tests
* Add contributors to config

* Add missing
* start fixing language server issues

* revert some changes, remove encode

* fix some more

* Update main.nf

* update methylation tests
* Fix sniffles1

* fix lint

* Add missing nf-test triggers

* update snaps
* Fix pipeline not running without `--vep_cache` (#553)

* Fix pipeline can't run without

* CHANGELOG

* docs

* docs

* update snaps

* fix CI

* Update CHANGELOG.md

* changelog date

* Add vep_plugin_files to files check

* CHANGELOG

* Update CHANGELOG.md

* always failing CI because of nf-core update

* CHANGELOG
Copy link

github-actions bot commented Feb 27, 2025

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit df2c5de

+| ✅ 188 tests passed       |+
#| ❔  24 tests were ignored |#
!| ❗  14 tests had warnings |!

❗ Test warnings:

❔ Tests ignored:

  • files_exist - File is ignored: CITATIONS.md
  • files_exist - File is ignored: CODE_OF_CONDUCT.md
  • files_exist - File is ignored: assets/nf-core-nallo_logo_light.png
  • files_exist - File is ignored: docs/README.md
  • files_exist - File is ignored: docs/images/nf-core-nallo_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-nallo_logo_dark.png
  • files_exist - File is ignored: .github/ISSUE_TEMPLATE/config.yml
  • files_exist - File is ignored: .github/workflows/awstest.yml
  • files_exist - File is ignored: .github/workflows/awsfulltest.yml
  • files_exist - File is ignored: conf/modules.config
  • files_exist - File is ignored: conf/igenomes_ignored.config
  • files_exist - File is ignored: conf/igenomes.config
  • files_exist - File is ignored: conf/test_full.config
  • nextflow_config - Config variable ignored: manifest.name
  • nextflow_config - Config variable ignored: manifest.homePage
  • files_unchanged - File ignored due to lint config: CODE_OF_CONDUCT.md
  • files_unchanged - File ignored due to lint config: .github/CONTRIBUTING.md
  • files_unchanged - File ignored due to lint config: .github/ISSUE_TEMPLATE/bug_report.yml
  • files_unchanged - File ignored due to lint config: assets/nf-core-nallo_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-nallo_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-nallo_logo_dark.png
  • files_unchanged - File ignored due to lint config: docs/README.md
  • files_unchanged - File ignored due to lint config: .gitignore or .prettierignore
  • modules_config - modules_config

✅ Tests passed:

Run details

  • nf-core/tools version 3.2.0
  • Run at 2025-03-03 14:48:43

* Update usage.md

* changelog
* Bump version 0.5.0

* CHANGELOG

* update snaps
@fellen31 fellen31 marked this pull request as ready for review March 3, 2025 08:37
@fellen31 fellen31 requested a review from a team as a code owner March 3, 2025 08:37
docs/index.md Outdated
@@ -93,7 +92,7 @@ For more details and further functionality, please refer to the [usage documenta

genomic-medicine-sweden/nallo was originally written by Felix Lenner.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
genomic-medicine-sweden/nallo was originally written by Felix Lenner.
genomic-medicine-sweden/nallo was originally written by [Felix Lenner](https://github.com/fellen31).

Copy link
Contributor

@rannick rannick left a comment

Choose a reason for hiding this comment

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

Fantastic!

@@ -93,7 +92,7 @@ For more details and further functionality, please refer to the [usage documenta

genomic-medicine-sweden/nallo was originally written by Felix Lenner.

We thank the following people for their extensive assistance in the development of this pipeline:
We thank the following people for their extensive assistance in the development of this pipeline: [Anders Jemt](https://github.com/jemten), [Annick Renevey](https://github.com/rannick), [Daniel Schmitz](https://github.com/Schmytzi), [Lucía Peña-Pérez](https://github.com/Lucpen), [Peter Pruisscher](https://github.com/peterpru) & [Ramprasad Neethiraj](https://github.com/ramprasadn).
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this the order of the most contribution? I see it is alphabetical, but maybe Daniel should be higher?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I hate to be the judge of who has contributed most 🙈 Even if it means you are listed second!

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

So yes, it's alphabetical.

Copy link
Contributor

Choose a reason for hiding this comment

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

I understand!

| `svs/family/{family_id}/{family_id}_svs_merged.vcf.gz.tbi` | Index of the merged VCF file | :white_check_mark: | | |
| `svs/family/{family_id}/{family_id}_cnvs_svs_merged.vcf.gz` | VCF file with merged CNVs and SVs per family | | | :white_check_mark: |
| `svs/family/{family_id}/{family_id}_cnvs_svs_merged.vcf.gz.tbi` | Index of the merged VCF file | | | :white_check_mark: |
SV and CNV calls are output unmerged per sample, while the family files are first merged between samples for SVs and CNVs separately, then the merged SV and CNV files are merged again, with priority given to coordinates from the SV calls. SV calls are output for all callers, but only variants from one caller (set by `--sv_caller`) are merged with CNVs, then annotated, ranked and filtered.
Copy link
Contributor

Choose a reason for hiding this comment

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

Would a little asterisk in the metro map help user understand the behaviour (but this doc is so clean that consider this very optional)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I have thought of the metro-map as a basic overview of the pipeline (not all steps are included there). This is complicated, but I think I would rather keep the metro-map on the cleaner side.

I think we will need to give this an overhaul at some point, e.g. being able to use several callers simultaneously, but also be able to filter out calls on a per-caller level.. So at that point I can draw up a schematic for this, to make it more clear.

@@ -18,12 +17,13 @@ process SPLIT_BED_CHUNKS {
// Chunk size needs to be > 0. Where to specify a needed argument? params?
// Will not output more regions than in file, even if chunk_size > number of regions
script:
def VERSION = "1.0"
Copy link
Contributor

Choose a reason for hiding this comment

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

Add comment specifying when that needs to be updated?

contribution: ['author','maintainer'],
orcid: 'https://orcid.org/0000-0002-9594-0710'
],
]
Copy link
Contributor

Choose a reason for hiding this comment

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

Here I would order in descending order of contribution, not ascending

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Completely unordered here!

@fellen31 fellen31 merged commit 74ff9f3 into master Mar 3, 2025
63 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants