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

updated changelog #103

Merged
merged 5 commits into from
Feb 27, 2025
Merged

updated changelog #103

merged 5 commits into from
Feb 27, 2025

Conversation

kbestak
Copy link
Collaborator

@kbestak kbestak commented Feb 25, 2025

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

@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 26, 2025 •
edited
Loading

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

Posted for pipeline commit 5300565

+| ✅ 227 tests passed       |+
#| ❔   1 tests were ignored |#
!| ❗  13 tests had warnings |!

❗ Test warnings:

  • pipeline_todos - TODO string in nextflow.config: Optionally, you can add a pipeline-specific nf-core config at https://github.com/nf-core/configs
  • pipeline_todos - TODO string in ro-crate-metadata.json: "description": "

    \n \n <source media="(prefers-color-scheme: dark)" srcset="docs/images/nf-core-molkart_logo_dark.png">\n <img alt="nf-core/molkart" src="docs/images/nf-core-molkart_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/molkart 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 1. Read QC (FastQC)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/molkart \\\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/molkart was originally written by @kbestak, @FloWuenne.\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 #molkart 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/molkart 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 methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline
  • local_component_structure - tiffh5convert.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - maskfilter.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - molkartqcpng.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - crophdf5.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - createanndata.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - croptiff.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - spot2cell.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - clahe.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - createstack.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - molkartqc.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure

❔ Tests ignored:

  • files_unchanged - File ignored due to lint config: .gitignore or .prettierignore

✅ Tests passed:

Run details

  • nf-core/tools version 3.2.0
  • Run at 2025-02-27 08:57:02

FloWuenne
FloWuenne requested changes Feb 26, 2025
View reviewed changes
jfy133
jfy133 approved these changes Feb 26, 2025
View reviewed changes
Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

New structure looks great, just missing the tool version updates from any tools that have updated their container/tools but otherwise ready to go

@kbestak
Copy link
Collaborator Author

kbestak commented Feb 27, 2025

In this case, some of the modules' containers were changed, but the tool version was kept the same (e.g. docker.io/vanvalenlab/deepcell-applications:0.4.1 -> nf-core/deepcell_mesmer:0.4.1_noentry to fix an issue because of which the full tests were failing). Should this be reflected in the dependency section of the changelog as well? If so what would be the best way?

@jfy133
Copy link
Member

jfy133 commented Feb 27, 2025 •
edited
Loading

Nope, just build changes are fine to exclude from changelog!

@kbestak kbestak requested a review from FloWuenne February 27, 2025 11:55
FloWuenne
FloWuenne approved these changes Feb 27, 2025
View reviewed changes
Copy link
Collaborator

@FloWuenne FloWuenne left a comment

Choose a reason for hiding this comment

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

LGTM 🚀 !

@kbestak kbestak merged commit a5e6a31 into nf-core:dev Feb 27, 2025
6 checks passed
@kbestak kbestak deleted the changelog branch February 27, 2025 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@FloWuenne FloWuenne FloWuenne approved these changes

@jfy133 jfy133 jfy133 approved these changes

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

Successfully merging this pull request may close these issues.
3 participants
@kbestak @jfy133 @FloWuenne