Skip to content

Pipeline description in README #111

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
Merged
merged 10 commits into from
Nov 24, 2025
Merged

Pipeline description in README #111

merged 10 commits into from
Nov 24, 2025

Conversation

@Patricie34
Copy link
Contributor

@Patricie34 Patricie34 commented Mar 26, 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/seqinspector 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).

@github-actions
Copy link

github-actions bot commented Mar 26, 2025 •
edited by nf-core-bot
Loading

Warning

Newer version of the nf-core template is available.

Your pipeline is using an old version of the nf-core template: 3.2.0.
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.

@Patricie34 Patricie34 changed the title Piepeline description in README Pipeline description in README Mar 26, 2025
@github-actions
Copy link

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

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

Posted for pipeline commit 81e4cfd

+| ✅ 181 tests passed       |+
#| ❔   4 tests were ignored |#
!| ❗  13 tests had warnings |!

❗ Test warnings:

  • readme - README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
  • pipeline_todos - TODO string in nextflow.config: Specify your pipeline's command line flags
  • 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 README.md: TODO nf-core:
  • pipeline_todos - TODO string in README.md: Include a figure that guides the user through the major workflow steps. Many nf-core
  • 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 ro-crate-metadata.json: "description": "

    \n \n <source media="(prefers-color-scheme: dark)" srcset="docs/images/nf-core-seqinspector_logo_dark.png">\n <img alt="nf-core/seqinspector" src="docs/images/nf-core-seqinspector_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/seqinspector 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/seqinspector \\\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/seqinspector was originally written by Adrien Coulier.\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 #seqinspector 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/seqinspector 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 base.config: Check the defaults for all processes
  • pipeline_todos - TODO string in base.config: Customise requirements for specific processes.
  • 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
  • pipeline_todos - TODO string in usage.md: Add documentation about anything specific to running your pipeline. For general topics, please point to (and add to) the main nf-core website.
  • actions_schema_validation - Failed to fetch schema: Response code for https://json.schemastore.org/github-workflow was 503

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 3.2.0
  • Run at 2025-11-06 13:13:10

@Patricie34 Patricie34 changed the base branch from master to dev March 26, 2025 13:41
@matrulda matrulda mentioned this pull request Mar 26, 2025
Closed
11 tasks
@torigiffin
Copy link

torigiffin commented Mar 26, 2025

I had some other ideas of stuff that would be helpful for beginners!

##Introduction:

  • I think it would be nice to add a code block of the -profile test command instead of just the flag in the text

##Usage:

I would say run directory not run dir

tags: I would say such as lanes, projects, etc.

  • tags are never explained as the like "marker" for the pipeline

Updating the pipeline:
Maybe this would be helpful near the beginning? nextflow pull nf-core/seqinspector maybe put the version command near it so you can do it all together

##Parameters:
--multiqc__title
"MultiQC report title for all generated reports"

I think the --fasta parameter being mandatory if there is no --genome is hidden in the help text on parameters page. I think somewhere in usage or intro it should say one or the other is necessary

matrulda
matrulda reviewed Mar 26, 2025
View reviewed changes
@Patricie34 @matrulda
Update README.md
6d60c9d 
Co-authored-by: Matilda Åslin <matilda.aslin@medsci.uu.se>
pontushojer
pontushojer reviewed Jul 9, 2025
View reviewed changes
mashehu
mashehu reviewed Nov 6, 2025
View reviewed changes
README.md
## Introduction

**nf-core/seqinspector** is a bioinformatics pipeline that ...
**nf-core/seqinspector** is a bioinformatics pipeline that that processes raw sequencedata (FASTQ) to provide comprehensive quality control. It can perform subsampling, quality assessment, duplication level analysis, and complexity evaluation on a per-sample basis, while also detecting adapter content, technical artifacts, and common biological contaminants. The pipeline generates detailed MultiQC reports with flexible output options, ranging from individual sample reports to project-wide summaries, making it particularly useful for sequencing core facilities and research groups with access to sequencing instruments.
Copy link

@mashehu mashehu Nov 6, 2025

Choose a reason for hiding this comment

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

please don't forget to add this also to the github repo description (in a shorter form)

Copy link
Member

@FranBonath FranBonath Nov 24, 2025

Choose a reason for hiding this comment

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

@mashehu where do you mean? On the pipelines overview page?

Copy link
Member

@FranBonath FranBonath Nov 24, 2025

Choose a reason for hiding this comment

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

opened a new issue for this

@maxulysse maxulysse added this to the 1.0.0 milestone Nov 6, 2025
@FranBonath FranBonath mentioned this pull request Nov 7, 2025
Closed
@maxulysse maxulysse added the documentation Improvements or additions to documentation label Nov 7, 2025
@FranBonath @pontushojer
Update README.md
8cfcdd1 
Co-authored-by: Pontus Höjer <pontus.hojer@scilifelab.se>
@FranBonath FranBonath mentioned this pull request Nov 24, 2025
Closed
@FranBonath FranBonath merged commit 1a8363e into nf-core:dev Nov 24, 2025
20 checks passed
MatthiasZepper pushed a commit to MatthiasZepper/nf-core_seqinspector that referenced this pull request Nov 28, 2025
@FranBonath
Merge pull request nf-core#111 from Patricie34/dev_docs
8f71810 
Pipeline description in README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@matrulda matrulda matrulda left review comments

@mashehu mashehu mashehu left review comments

@pontushojer pontushojer pontushojer left review comments

@FranBonath FranBonath FranBonath approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

1.0.0

Development

Successfully merging this pull request may close these issues.

7 participants

@Patricie34 @torigiffin @matrulda @mashehu @pontushojer @FranBonath @maxulysse