Skip to content

Commit

Permalink
Merge pull request #44 from pdimens/docs_dev
Browse files Browse the repository at this point in the history
add bc threshold diagram
  • Loading branch information
pdimens authored Feb 20, 2024
2 parents 776d3a4 + 5f3a986 commit 193e620
Show file tree
Hide file tree
Showing 5 changed files with 770 additions and 1 deletion.
3 changes: 3 additions & 0 deletions commonoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ harpy align bwa --threads 20 --directory samples/trimmedreads --quiet

harpy align bwa -t 20 -d samples/trimmedreads -q
```
---

## The `workflow` folder
When you run one of the main Harpy modules, the output directory will contain a `workflow` folder. This folder is
Expand All @@ -45,6 +46,8 @@ and the contents therein also allow you to rerun the workflow manually. The `wor
| `report/*.Rmd` | RMarkdown files used to generate the fancy reports | useful to understand math behind plots/tables or borrow code from |
| `*.workflow.summary` | Plain-text overview of the important parts of the workflow | useful for bookkeeping and writing Methods |

---

## The `Genome` folder

You will notice that many of the workflows will create a `Genome` folder in the working
Expand Down
9 changes: 8 additions & 1 deletion haplotagdata.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,11 @@ same barcode (on the same contig), then we'll consider them as originating from
you are being more strict and indicating that alignments sharing barcodes must be closer together to be considered originating from the same
DNA molecule. Conversely, a higher threshold indicates you are being more lax and indicating barcodes can be further away from each other
and still be considered originating from the same DNA molecule. A threshold of 50kb-150kb is considered a decent balance, but you should choose
larger/smaller values if you have evidence to support them.
larger/smaller values if you have evidence to support them.

![Molecule origin is determined by the distance between alignments with the same barcode relative to the specified threshold](/static/bc_threshold.png)

| Alignment distance | Inferred origin |
|:-----------------------|:--------------------|
| less than threshold | same molecule |
| greater than threshold | different molecules |
Binary file modified static/EMA.fig3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/bc_threshold.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 193e620

Please sign in to comment.