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.

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

docs: added some pages #27

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions docs/alignment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Alignment

rulegraph
2 changes: 2 additions & 0 deletions docs/cnv_sv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# CNV SV
hello
Binary file added docs/images/rulegraph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion docs/includes/abbreviations.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
*[DNA]: Deoxyribonucleic acid
*[DNA]: Deoxyribonucleic acid
*[GMS]: Genome Medicin Sweden
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<img src="static/poppy_light.svg" style="height: 200px;" />

Poppy is a Snakemake pipeline used for analysing hybrid capture short-read sequencing data from the [Genomic Medicine Sweden](https://genomicmedicine.se/en/) myeloid gene panels.
[Poppy](https://github.com/genomic-medicine-sweden/Twist_DNA_Hematology) is a Snakemake pipeline used for analysing hybrid capture short-read sequencing data from the [Genomic Medicine Sweden](https://genomicmedicine.se/en/) myeloid gene panels.

# Hydra-genetics

Expand Down
4 changes: 3 additions & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Introduction

Poppy is a Snakemake pipeline used for analysing hybrid capture short-read sequencing data from the [Genomic Medicine Sweden](https://genomicmedicine.se/en/) myeloid gene panels.
[Poppy](https://github.com/genomic-medicine-sweden/Twist_DNA_Hematology) is a Snakemake pipeline used for analyzing hybrid capture short-read sequencing data from the [Genomic Medicine Sweden](https://genomicmedicine.se/en/) (GMS) myeloid gene panels. It uses the [Hydra-Genetics](https://github.com/hydra-genetics) framework.

![rule graph](images/rulegraph.png){: style="height:90%;width:90%"}
22 changes: 22 additions & 0 deletions docs/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Overview of the pipeline
Here is a brief overview of the entire tumor pipeline. For details see subsections and the [hydra-genetics](https://github.com/hydra-genetics/hydra-genetics) documentation.

## Prealignment and Alignment
- Input files: fastq
- Trimming: fastp_pe
- Alignment: bwa mem

## SNV_indels
Serveral variant callers are used and then normalized and decomponated with vt, then merged with bcbios ensemble into one vcf. That vcf is then annotated using vep.

SNV callers:
- GATK mutect2
- Vardict
- Freebayes


## CNV_SV

## QC
The following qc tools are used and then merged into a single report using MultiQC.

3 changes: 3 additions & 0 deletions docs/prealignment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Prealignment

I like this https://twist-solid.readthedocs.io/en/stable/dna_prealignment/
2 changes: 2 additions & 0 deletions docs/qc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# QC
hello
2 changes: 2 additions & 0 deletions docs/reference_overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Reference pipeline
Pipeline used to produce reference files such as CNV pools of normals
3 changes: 3 additions & 0 deletions docs/reference_setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Reference pipeline set-up

Set upo and running the reference pipeline instructions
2 changes: 2 additions & 0 deletions docs/results_file.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Results files
The following files are produced by the pipeline..
4 changes: 4 additions & 0 deletions docs/snv_indels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# SNV indels
rulegraph

annotation and filtering here as well
745 changes: 745 additions & 0 deletions images/rulegraph.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 15 additions & 2 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
site_name: Poppy
nav:
- Introduction: intro.md
- Software: software.md
- Overview:
- Introduction: intro.md
- Overview: overview.md
- Results files: results_file.md
- Pipeline:
- Prealignment: prealignment.md
- Alignment: alignment.md
- SNV_indels: snv_indels.md
- CNV_SV: cnv_sv.md
- QC: qc.md
- Pipeline specific rules:
- Software: software.md
- Reference Pipeline:
- Overview: reference_overview.md
- Set up and running: reference_setup.md

theme: readthedocs
extra_css: [extra.css]
Expand Down