README.md

# Help4MultiQC

https://bios4biol.pages.mia.inra.fr/Help4MultiQC/

This page will present haw to interpret results metrics compiled by multiQCreport obtainent on standard NGS pipelines such as RNAseq, 16S metaGenomics, ...

This work is coordinated by CATI Bios4Biol at INRAE.

You can find informations on [MultiQC page](https://multiqc.info/) and notably an example of a [MultiQC report for RNAseq data](https://multiqc.info/examples/rna-seq/multiqc_report.html).


## Getting started

...

## Support
For any comment, suggestion or issue, please feel free to contact us directly or open an issue (https://forgemia.inra.fr/bios4biol/Help4MultiQC/-/issues).

## Contributing
Anyone who would like to contribute to this work to improve the content or add descriptions for a new QC module is welcome.
We invite them to contact a member of the contributing authors directly prior to taking any action.

## Authors and acknowledgment 
This work is populated by CATI Bios4Biol with the contribution of [Sarah Maman-Haddad](https://forgemia.inra.fr/sarah.maman-haddad) @sarah.maman-haddad , [Claire Hoede](https://forgemia.inra.fr/claire.hoede) @claire.hoede and [Yannick Lippi](https://forgemia.inra.fr/ylippi) @ylippi.

The contents of these pages are mainly inspired by already published contents :
* https://elearning.formation-permanente.inrae.fr/course/view.php?id=196&section=1
* https://github.com/nf-core/rnaseq/blob/master/docs/output.md#quality-control
* https://github.com/hbctraining/Intro-to-rnaseq-hpc-salmon/blob/master/lessons/qc_fastqc_assessment.md
* https://youtu.be/qPbIlO_KWN0
* https://multiqc.info/docs/#using-multiqc
* https://rtsf.natsci.msu.edu/genomics/tech-notes/fastqc-tutorial-and-faq/

## License
<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.

## Project status

- [x] writing content for the fastQC module.
- [ ] writing content for other modules (cutadapt, STAR, FeatureCounts, ...).
- [ ] Integration of links to the help pages in each module of MultiQCreport template.