Skip to content

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
tdayris committed Dec 5, 2023
1 parent 9f9c862 commit f7b9b72
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A complete description of the results can be found here in [workflow reports](ht

## Material and Methods

The tools used in this pipeline are described [here](https://github.com/tdayris/fair_bowtie2_mapping/blob/main/workflow/report/workflows.rst) textually. Web-links are available below:
The tools used in this pipeline are described [here](https://github.com/tdayris/fair_bowtie2_mapping/blob/main/workflow/report/material_methods.rst) textually. Web-links are available below:

![workflow_rulegraph](dag.png)

Expand Down Expand Up @@ -50,7 +50,8 @@ The tools used in this pipeline are described [here](https://github.com/tdayris/

### QC

| Step | Wrapper |
| ------- | -------------------------------------------------------------------------------------------------------------------------------- |
| Picard | [picard-collectmultiplemetrics](https://snakemake-wrappers.readthedocs.io/en/stable/wrappers/picard/collectmultiplemetrics.html) |
| MultiQC | [multiqc-wrapper](https://snakemake-wrappers.readthedocs.io/en/stable/wrappers/multiqc.html) |
| Step | Wrapper |
| -------- | -------------------------------------------------------------------------------------------------------------------------------- |
| Picard | [picard-collectmultiplemetrics](https://snakemake-wrappers.readthedocs.io/en/stable/wrappers/picard/collectmultiplemetrics.html) |
| Samtools | [samtools-stats](https://snakemake-wrappers.readthedocs.io/en/stable/wrappers/samtools/stats.html) |
| MultiQC | [multiqc-wrapper](https://snakemake-wrappers.readthedocs.io/en/stable/wrappers/multiqc.html) |
5 changes: 3 additions & 2 deletions workflow/report/material_methods.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ genome annotation files.
Raw fastq files were trimmed using Fastp_ [#fastppaper]_ . Cleaned reads were aligned
over indexed Ensembl genome with Bowtie2_ [#bowtie2paper]_. Sambamba_ [#sambambapaper]_
was used to sort, filter, mark duplicates, and compress aligned reads. Quality
controls were done using Picard_ [#picardpaper]_. Quality repord produced during both
trimming and mapping steps have been aggregated with MultiQC_ [#multiqcpaper]_. The
controls were done on cleaned, sorted, deduplicated aligned reads using
Picard_ [#picardpaper]_ and Samtools_ [#samtoolspaper]_. Quality repord produced during
both trimming and mapping steps have been aggregated with MultiQC_ [#multiqcpaper]_. The
whole pipeline was powered by Snakemake_ [#snakemakepaper]_.

This pipeline is freely available on Github_, details about installation
Expand Down

0 comments on commit f7b9b72

Please sign in to comment.