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

Name change: Skierfe -> Nallo #39

Merged
merged 11 commits into from
Apr 22, 2024

Conversation

fellen31
Copy link
Collaborator

@fellen31 fellen31 commented Mar 25, 2024

To stay on Maxime's good side make the pipeline name pronounceable in English, let's change mountains!

  • Favorite place
  • Nallo: Not another <Insert L-adjective> long-read pipeline
  • Means Needle which kinda fits the purpose
  • Is not the logo of nf-core/sarek

Plan?

  • Inform forks of name change (only me and Lund at the moment)
  • Change repo name
  • Merge this PR

Nallo

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 fellen31/skierfe 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>).
  • 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).

@maxulysse
Copy link

It's true that Skierfe is the actual mountain depicted in the Sarek logo, and the codename of a sarek release, but for me this is not really an issue.

I'm more concerned into what is the plan for the future, like do you want to port it to nf-core?

@fellen31
Copy link
Collaborator Author

I'm more concerned into what is the plan for the future, like do you want to port it to nf-core?

I think maybe it would be best just to see in which direction this is going to go for a little while, especially now that I will have more time to actively work on it.

If it is a "raredisease-LR", should it take both PacBio and ONT-data (and maybe even parental Illumina data for assembly?), and would that be okay with the nf-core guidelines? Would nf-core want a "sarek-LR", or should it be one nanoseq-DNA and one pacbio-DNA pipeline?

In the meantime, I'm all for contributing to modules and subworkflows in nf-core. And I am for porting it to nf-core at some point, either the whole pipeline or its parts. I'll work on bringing the pipeline as close to the nf-core standards as possible, to make that transition easier.

Copy link

github-actions bot commented Apr 18, 2024

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit e40dd9e

+| ✅ 154 tests passed       |+
#| ❔  16 tests were ignored |#
!| ❗  16 tests had warnings |!

❗ Test warnings:

  • nextflow_config - Config manifest.version should end in dev: 0.1.0
  • readme - README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
  • pipeline_todos - TODO string in README.md: Add full-sized test dataset and amend the paragraph below if applicable
  • pipeline_todos - TODO string in README.md: If applicable, make list of people who have also contributed
  • pipeline_todos - TODO string in README.md: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file.
  • pipeline_todos - TODO string in README.md: Add bibliography of tools and data used in your pipeline
  • pipeline_todos - TODO string in test_full.config: Specify the paths to your full test data ( on nf-core/test-datasets or directly in repositories, e.g. SRA)
  • pipeline_todos - TODO string in test_full.config: Give any required params for the test so that command line flags are not needed
  • pipeline_todos - TODO string in ci.yml: You can customise CI pipeline run tests as required
  • pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required
  • pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
  • pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline
  • schema_description - No description provided in schema for parameter: hificnv_xy
  • schema_description - No description provided in schema for parameter: hificnv_xx

❔ Tests ignored:

  • 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/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
  • 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

✅ Tests passed:

Run details

  • nf-core/tools version 2.13.1
  • Run at 2024-04-22 07:21:15

@fellen31 fellen31 marked this pull request as ready for review April 18, 2024 10:46
@fellen31 fellen31 requested a review from jemten as a code owner April 18, 2024 10:46
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.

There is a file conflict that needs to be solved. And found some pointers to your private repo. The files looks like they are present on this repo as well but they are on the dev branch here.

@@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://raw.githubusercontent.com/fellen31/skierfe/master/assets/schema_gvcfs.json",
"title": "fellen31/skierfe pipeline - params.extra_gvcfs schema",
"$id": "https://raw.githubusercontent.com/fellen31/nallo/master/assets/schema_gvcfs.json",
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
"$id": "https://raw.githubusercontent.com/fellen31/nallo/master/assets/schema_gvcfs.json",
"$id": "https://raw.githubusercontent.com/genomic-medicine-sweden/nallo/master/assets/schema_gvcfs.json",

Copy link
Collaborator

Choose a reason for hiding this comment

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

Can't find this file on the master branch of this repo but it is there on dev

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hm, there's no master branch on fellen31/skierfe anymore since it's now a fork of this repo, but the file still exists there https://raw.githubusercontent.com/fellen31/skierfe/master/assets/schema_gvcfs.json but not on the gms master.

For this PR to pass the tests after name change it would have to point to the dev branch. Or the file first needs to be pushed to the master branch? Will soon have the same problem for all test data.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Can take this in the release PR along with the other test-data.

fellen31 and others added 10 commits April 22, 2024 09:14
Co-authored-by: Anders Jemt <jemten@users.noreply.github.com>
Co-authored-by: Anders Jemt <jemten@users.noreply.github.com>
Co-authored-by: Anders Jemt <jemten@users.noreply.github.com>
Co-authored-by: Anders Jemt <jemten@users.noreply.github.com>
* bump versions
* clear changelog
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.

💥

@fellen31 fellen31 merged commit c2d717c into genomic-medicine-sweden:dev Apr 22, 2024
6 checks passed
@fellen31 fellen31 deleted the name-change branch April 22, 2024 08:45
fellen31 added a commit that referenced this pull request May 8, 2024
* Add methylation calls to bedmethyl

* Output whatshap stats, and add pipeline presets

* Fix mosdepth not running for all samples

* Fix methylation sample mix

* fix dipcall not working

* Add fastq and bam stats

* fix dipcall not working

* Rework modules and subworkflows to match new-found knowledge about single element channels

* Added TRGT for pacbio-data

* Fix repeat versions

* Fix samtools index publishdirs

* Add back --secondary=no to minimap2 align

* Fix cramino phased and unphased

* Update README.md

* Fix dipcall sample name in vcf

* Fix trgt container adress

* try again to fix trgt container adress

* remove TRVZ because it will create too many processes

* completely remove TRVZ

* update modules conf, missing output files, index bams and fix containers

* Fix minimap2 index always using default params

* minimap index needs to be built separate for dipcall as well

* tweak process requirements

* Improve whatshap phasing

* Add hiphase

* add missing bcftools modules

* Add samplesheet, extra_gcvf and extra_snfs validation

* update hifiasm

* completely remove PED and rely on samplesheet

* fix methylation bug

* update modkit, removes now unneccesary creation of haplotype bams

* Formatting, remove unneccessary inputs

* fix leftover flag in pileup

* Add skip for phasing and remove more PED references

* Simplify sniffles, and put back dipcall par

* Update README.md

* Add skip for QC

* Update hiphase output files

* Add hificnv to workflow

* nf-download not working..

* add config

* Add missing file column to snfs schema

* Add hificnv to workflow

* nf-download not working..

* add config

* Update README.md

Remove reference to ped-file

* Update README.md

* Update align.nf

If using BAM-files as input for pbmm2, then don't output those.

* Replaces pbmm2 with minimap2, using the nf-core modules

* Fix typo

* Add missing diff..linting fails because of the container URL, not sure how to fix?

* linting working for all but samtools/faidx

* Update README.md

* Added DeepTrio support (incl. GPU for both DV and DT), trios extractedfrom PED-file

* Update README.md

* Small clean up.

* Add deeptrio, GPU support and fastqc (should get better at keeping features separate)

* fix minimap2 singularity version

* Added dipcall

* Add dipcall as process

* Might have messed up git stash

* Rewrite fix_trio process in Groovy, add hifiasm-trio and dipcall

* Merge updated TEMPLATE

* Update modules after TEMPLATE upgrade

* More modules fixes to bring it closer to nf-core

* Prettier

* Replace fix_trio process for deeptrio input

* remove nf-core images and add pipeline summary

* Update README.md

* fix color

* Allow to skip either assembly or read_map calling

* Update docs

* Remove references to non-existing slack

* Add tandem-regions and reference back to sniffles + skip snv-calling

* reorganise publishdirs

* move yak-versions into trio workflow

* Fix non-trio hifiasm and add more rememberable skips

* Fix dipcall module?

* Update genome_assembly.nf

* See if this way works

* See if this way works-2

* See if this way works-3

* nf-core download would not pull docker image when the container is specified inside single quotes

* Update dipcall to use PED-file in non-trio mode

* Update base config to better represent needs

* Change hifiasm to nf-core module, but make it output lowQ beds as well

* add mosdepth

* fix dipcall bug

* Revert "fix dipcall bug"

This reverts commit 36b9768.

* Revert "Revert "fix dipcall bug"" - sorry git log

This reverts commit 713272e.

* Hope to have fixed all dipcall bugs - but need more testing

* Change local GLNexus to nf-core module

* Make tandem_repeats optional, since it might not be that great?

* Update README.md

* Add methylation calls to bedmethyl

* Output whatshap stats, and add pipeline presets

* Fix mosdepth not running for all samples

* Fix methylation sample mix

* fix dipcall not working

* Add fastq and bam stats

* fix dipcall not working

* Rework modules and subworkflows to match new-found knowledge about single element channels

* Added TRGT for pacbio-data

* Fix repeat versions

* Fix samtools index publishdirs

* Add back --secondary=no to minimap2 align

* Fix cramino phased and unphased

* Fix dipcall sample name in vcf

* Update README.md

* Fix trgt container adress

* try again to fix trgt container adress

* remove TRVZ because it will create too many processes

* completely remove TRVZ

* update modules conf, missing output files, index bams and fix containers

* Fix minimap2 index always using default params

* minimap index needs to be built separate for dipcall as well

* tweak process requirements

* Improve whatshap phasing

* Add hiphase

* add missing bcftools modules

* Add samplesheet, extra_gcvf and extra_snfs validation

* update hifiasm

* completely remove PED and rely on samplesheet

* fix methylation bug

* update modkit, removes now unneccesary creation of haplotype bams

* Formatting, remove unneccessary inputs

* fix leftover flag in pileup

* Add skip for phasing and remove more PED references

* Simplify sniffles, and put back dipcall par

* Update README.md

* Add skip for QC

* Update hiphase output files

* Add missing file column to snfs schema

* Update README.md

Remove reference to ped-file

* Annotate variants with one database

* Change to list of dbs

* Fix anno overwriting input with output

* Fix anno output file

* Add VEP annotation

* Update README and schema etc.

* Add 'hack' to be able to run ONT-files in TRGT

* Update README

* Update README.md

* Update README.md

* Split alignment for faster processing

* Call variants per regions in bed/fai

* Extracting regions from extra gVCFs takes too long

* Singularity image does not contain jemalloc

* Grab correct one

* glnexus will load full files into db even with bed

* split DV input in 13 instead of n regions in BED

* forgot wf

* Clean up, remove PMD/DT as snv-callers, and ONT_R9 as preset

* Remove index split alignments & update README

* Update README

* Update README.md

* Update README.md

* Add grouptuple size so downstream wf's don't have to wait for all samples to complete

* pipeline would freeze depending on number of regions specified

* better outputdirs for aligned reads

* Update docs with pipeline parameters

* Update README

* Update README.md

* Remove nf-core reference

* Split module configs

* Fix most process outdirs

* minimap2 soft-clips supplementary reads by default

* update hificnv config

* Add expected CN-files (for XX/XY), MAF-vcf and option to use an exclude regions file. Also update HiFiCNV version to v.0.1.7

* Use BED file for mosdepth

* Fix mosdepth running without BED

* Update samtools_cat_sort_index.nf

Fix args bug

* Fix sniffles args bug

* Update short_variant_calling.config

Merged SNV-vcfs output files were misssing

* Fix actually skipping CNV workflow is specifying so

* Update qc_aligned_reads.nf

Fix mosdepth bed input

* Update qc_aligned_reads.nf

* Update split_bed_chunks.py

Sometimes, the BED-output was with decimals. Difference between system?

* Update split_bed_chunks.py

* Update split_bed_chunks.py

Check that BED-file does not contain any spaces instead.

* Update README.md

* adding codeowners

* Add test profile and data (#33)

Add small test profile and data, hg38 asset files and code formatting.

* Update pipeline to run with a small test dataset (#35)

Reduce memory requirements, allow gzipped reference, single sample run and add BED file in modkit.

* Template merge 2.13.1 (#38)

Merge template version 2.13.1

* Fix bcftools merge (#43)

Fix bcftools merge
---------

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

* Add Revio BAM test data and a multisample-BAM samplesheet (#50)

Add BAM test data and a multisample-BAM samplesheet

* Add support for uBAM and multisample test (#51)

Add ubam support and multisample test

* Update usage docs (#53)

update usage docs

---------

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

* use biocontainer for glnexus

* change to pacbio registry

* run pre-commit

* Update CHANGELOG

* Fixed mosdepth input channel bug when bedfile is not provided

* Update module configs (#65)

Update config output directories and add minimal documentation

* Fix checking whether input files exist (#67)

* Add back files exist check, and fromSamplesheet

* Add CNV calling workflow to test profile  (#68)

* Don't skip cnv calling workflow

* Updated CHANGELOG.md

* Add SNV annotation test data (#76)

* Fix path in snp_dbs.csv (#77)

* Refactor parameters validation (#69)

* Refactor parateters validation

---------

Co-authored-by: Peter Pruisscher <57712924+peterpru@users.noreply.github.com>

* Add SNV annotation to test profile (#75)

* fix version reporting (#84)

* Run a single phasing software instead of three in parallel (#83)

* Remove leftover print (#88)

* Release prep v.0.1.0 (#89)

* bump versions
* clear changelog

* Name change: Skierfe -> Nallo   (#39)

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

* Change testdata location (#91)

* move test data
* add dummy samplesheet

* Update sniffles module (#92)

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

* update deepvariant module (#93)

* Add stubs (#94)

* update download pipeline (#95)

* Update README.md

* Update README.md

* Update docs/usage.md

* Update docs/usage.md

* Update docs/usage.md

* Update docs/usage.md

* Update docs/usage.md

* Delete annotations directory (#97)

* Delete assets/test_data directory (#99)

* Update download_pipeline.yml (#96)

* Update snv_annotation.config (#98)

Full size test fails because only `BCFTOOLS_NORM_SINGLESAMPLE` and not `BCFTOOLS_NORM` was actually decomposing variants.

* Update conf/modules/structural_variant_calling.config

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

* Apply suggestions from code review and full test issues (#107)

* Add review suggestions + full test changes

* Update CODEOWNERS (#112)

* Update CODEOWNERS

Change the code-owners to the GitHub team. This way we can more easily change the team and not having to update the CODEOWNERS

* Fixed org

* Update whatshap stats version to avoid ZeroDivisionError (#133)

* Update whatshap stats version to avoid ZeroDivisionError

* Update release date

* Update bcftools merge (#134)

* Bump date in changelog

* Since sex is now numberic, update branching criteria

* Was fixed before, but was overwritten

---------

Co-authored-by: Anders Jemt <jemten@users.noreply.github.com>
Co-authored-by: Ram Nanduri <Ram.Nanduri@skane.se>
Co-authored-by: Peter Pruisscher <57712924+peterpru@users.noreply.github.com>
Co-authored-by: Anders Lind <64251477+pbiology@users.noreply.github.com>
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