Skip to content

READ.me update #104

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

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

READ.me update #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0171a2
Add files via upload
GustavoYnada Mar 25, 2025
2409a28
Update README.md
GustavoYnada Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,19 @@

## Introduction

**nf-core/seqinspector** is a bioinformatics pipeline that ...
**nf-core/seqinspector** -
<p align="justify"><br>a basic QC pipeline for sequencing core facilities providing high quality data from a range of different sequencing instruments to their users is in the interest of every sequencing facility. In order to monitor their sequencing quality, performing standardized, yet flexible quality controls for every sequencing project and sample that passes through their facilities is crucial to ensure consistent quality and dependable results.</br>
<br>The Nextflow pipeline nf-core/seqinspector is envisioned as a unified quality control pipeline for sequencing data originating from instruments of various providers like Illumina, Oxford Nanopore Technologies or Pacific Biosciences.</br>
<br>It will assess sequencing quality, duplication levels and complexity on a per-sample basis, in addition to highlighting adapter contents and technical artifacts. Furthermore, it will facilitate the detection of common biological contaminants that may have been introduced to the samples before or during library preparation.</br>
<br>Since facilities share their flowcells and even sequencing lanes between different projects, the report generation will be particularly versatile and customizable. Quality reports can be obtained with a variable granularity ranging from individual samples or projects to whole flow cells. Therefore, receiving one single MultiQC report that summarizes all input samples, or having individual MultiQC reports for sample groups determined by the sample sheet will be possible.</br>
<br>While nf-core/seqinspector is developed by and for core facilities, it will also be a useful QC solution for research groups that own or have access to a sequencer outside of facilities. This project is still under development, and we are happy to welcome collaborators.</br></p>

<h1>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/images/seqinspector_poster_2024_v4.png">
<img src="docs/images/seqinspector_poster_2024_v4.png">
</picture>
</h1>
Comment on lines +22 to +34
Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks for working on improving the readme :)

In the todo on line 37 below, it says this description should only be 2-3 sentences long, could you maybe summarize your text so that it fits this constraint?

Also I'm not sure the poster belongs here, you could reuse the figure, but then you should adapt it so that it fits this readme.

Copy link
Member

Choose a reason for hiding this comment

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

hej @GustavoYnada, thanks for starting this! You have currently 2 PRs open, is #101 a duplicate of this one? Do we need both?

Copy link

Choose a reason for hiding this comment

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

Ah yes, I just reviewed #101 , but it is definitely a duplicate. I will close that one.

Copy link

Choose a reason for hiding this comment

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

Like I wrote in that review, I think it would make sense to use the tube map as illustration of the pipeline #85


<!-- TODO nf-core:
Complete this sentence with a 2-3 sentence summary of what types of data the pipeline ingests, a brief overview of the
Expand Down
Binary file added docs/images/seqinspector_poster_2024_v4.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading