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.

Sign up for GitHub

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

Jump to bottom

Refactor authors to list of contributors #222

Merged
merged 10 commits into from
Jan 27, 2025
Merged

Refactor authors to list of contributors #222

merged 10 commits into from
Jan 27, 2025

Conversation

heuermh
Copy link
Contributor

@heuermh heuermh commented Jan 17, 2025

Fixes #221

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

@heuermh heuermh mentioned this pull request Jan 17, 2025
Closed
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 17, 2025 •
edited
Loading

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

Posted for pipeline commit 312e13c

+| ✅ 232 tests passed       |+
#| ❔   3 tests were ignored |#
!| ❗   6 tests had warnings |!

❗ Test warnings:

  • files_exist - File not found: conf/igenomes.config
  • files_exist - File not found: conf/igenomes_ignored.config
  • pipeline_todos - TODO string in ro-crate-metadata.json: "description": "

    \n \n <source media="(prefers-color-scheme: dark)" srcset="docs/images/nf-core-pangenome_logo_dark.png">\n <img alt="nf-core/pangenome" src="docs/images/nf-core-pangenome_logo_light.png">\n \n

    \n\nGitHub Actions CI Status\nGitHub Actions Linting StatusAWS CICite with Zenodo\nnf-test\n\nNextflow\nrun with conda\nrun with docker\nrun with singularity\nLaunch on Seqera Platform\n\nGet help on SlackFollow on TwitterFollow on MastodonWatch on YouTube\n\n## Introduction\n\nnf-core/pangenome is a bioinformatics pipeline that ...\n\n TODO nf-core:\n Complete this sentence with a 2-3 sentence summary of what types of data the pipeline ingests, a brief overview of the\n major pipeline sections and the types of output it produces. You're giving an overview to someone new\n to nf-core here, in 15-20 seconds. For an example, see https://github.com/nf-core/rnaseq/blob/master/README.md#introduction\n\n\n Include a figure that guides the user through the major workflow steps. Many nf-core\n workflows use the "tube map" design for that. See https://nf-co.re/docs/contributing/design_guidelines#examples for examples. \n Fill in short bullet-pointed list of the default steps in the pipeline 2. Present QC for raw reads (MultiQC)\n\n## Usage\n\n> [!NOTE]\n> If you are new to Nextflow and nf-core, please refer to this page on how to set-up Nextflow. Make sure to test your setup with -profile test before running the workflow on actual data.\n\n Describe the minimum required steps to execute the pipeline, e.g. how to prepare samplesheets.\n Explain what rows and columns represent. For instance (please edit as appropriate):\n\nFirst, prepare a samplesheet with your input data that looks as follows:\n\nsamplesheet.csv:\n\ncsv\nsample,fastq_1,fastq_2\nCONTROL_REP1,AEG588A1_S1_L002_R1_001.fastq.gz,AEG588A1_S1_L002_R2_001.fastq.gz\n\n\nEach row represents a fastq file (single-end) or a pair of fastq files (paired end).\n\n\n\nNow, you can run the pipeline using:\n\n update the following command to include all required parameters for a minimal example \n\nbash\nnextflow run nf-core/pangenome \\\n -profile <docker/singularity/.../institute> \\\n --input samplesheet.csv \\\n --outdir <OUTDIR>\n\n\n> [!WARNING]\n> Please provide pipeline parameters via the CLI or Nextflow -params-file option. Custom config files including those provided by the -c Nextflow option can be used to provide any configuration except for parameters; see docs.\n\nFor more details and further functionality, please refer to the usage documentation and the parameter documentation.\n\n## Pipeline output\n\nTo see the results of an example test run with a full size dataset refer to the results tab on the nf-core website pipeline page.\nFor more details about the output files and reports, please refer to the\noutput documentation.\n\n## Credits\n\nnf-core/pangenome was originally written by Simon Heumos, Michael L Heuer.\n\nWe thank the following people for their extensive assistance in the development of this pipeline:\n\n If applicable, make list of people who have also contributed \n\n## Contributions and Support\n\nIf you would like to contribute to this pipeline, please see the contributing guidelines.\n\nFor further information or help, don't hesitate to get in touch on the Slack #pangenome channel (you can join with this invite).\n\n## Citations\n\n Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file. \n If you use nf-core/pangenome for your analysis, please cite it using the following doi: 10.5281/zenodo.XXXXXX \n\n Add bibliography of tools and data used in your pipeline \n\nAn extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md file.\n\nYou can cite the nf-core publication as follows:\n\n> The nf-core framework for community-curated bioinformatics pipelines.\n>\n> Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.\n>\n> Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x.\n",
  • 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!

❔ Tests ignored:

  • files_unchanged - File ignored due to lint config: assets/nf-core-pangenome_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-pangenome_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-pangenome_logo_dark.png

✅ Tests passed:

Run details

  • nf-core/tools version 3.1.2
  • Run at 2025-01-27 16:27:59

AndreaGuarracino
AndreaGuarracino reviewed Jan 17, 2025
View reviewed changes
nextflow.config Outdated
],
[
name: 'Andrea Guarracino',
affiliation: """Genomics Research Centre, Human Technopole, Milan, Italy""",
Copy link
Contributor

Choose a reason for hiding this comment

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

My affiliation is the same as Erik

University of Tennessee Health Science Center, Memphis, Tennessee, TN, USA

AndreaGuarracino
AndreaGuarracino reviewed Jan 17, 2025
View reviewed changes
nextflow.config Outdated
],
[
name: 'Erik Garrison',
affiliation: """The University of Tennessee Health Science Center, Memphis, Tennessee, TN, USA""",
Copy link
Contributor

Choose a reason for hiding this comment

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

Okay, but without the "The"

mirpedrol
mirpedrol reviewed Jan 18, 2025
View reviewed changes
nextflow.config Outdated Show resolved Hide resolved
@heuermh heuermh requested a review from subwaystation January 23, 2025 18:01
Zethson
Zethson approved these changes Jan 27, 2025
View reviewed changes
nextflow.config Outdated
email: '',
github: '@zethson',
contribution: ['contributor'],
orcid: ''
Copy link
Member

Choose a reason for hiding this comment

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

https://orcid.org/0000-0002-8937-3457

FriederikeHanssen
FriederikeHanssen reviewed Jan 27, 2025
View reviewed changes
README.md Outdated Show resolved Hide resolved
FriederikeHanssen
FriederikeHanssen reviewed Jan 27, 2025
View reviewed changes
nextflow.config Outdated Show resolved Hide resolved
FriederikeHanssen
FriederikeHanssen reviewed Jan 27, 2025
View reviewed changes
nextflow.config Outdated Show resolved Hide resolved
@heuermh @FriederikeHanssen
Apply suggestions from code review
c8a7f9a 
Co-authored-by: Friederike Hanssen <[email protected]>
@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.1.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.

@heuermh heuermh merged commit f5fb5a8 into nf-core:dev Jan 27, 2025
16 checks passed
@heuermh
Copy link
Contributor Author

heuermh commented Jan 27, 2025

Thank you for the review, @Zethson!

@heuermh heuermh deleted the contributors branch January 27, 2025 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AndreaGuarracino AndreaGuarracino AndreaGuarracino left review comments

@FriederikeHanssen FriederikeHanssen FriederikeHanssen left review comments

@mirpedrol mirpedrol mirpedrol left review comments

@Zethson Zethson Zethson approved these changes

@subwaystation subwaystation Awaiting requested review from subwaystation

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@heuermh @nf-core-bot @mirpedrol @FriederikeHanssen @Zethson @AndreaGuarracino