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

fixed README.md formatting #18

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ BCR heavy (IgH) and light (Igk/IgL) chains.

V'DJer accepts a sorted and indexed BAM file mapped to hg38 as input. We currently
use STAR for alignment. At the end of a run assembled contigs will appear in
```vdj_contigs.fa``` and reads aligned to those contigs are written to ```stdout```
`vdj_contigs.fa` and reads aligned to those contigs are written to `stdout`

The V'DJer output is suitable for use by downstream quantification tools such as [RSEM](http://deweylab.github.io/RSEM/).

## Getting the code and building the software

Use a recent release: https://github.com/mozack/vdjer/releases

To compile, just cd into the vdjer directory and type ```make```. An executable named
```vdjer``` will be created.
To compile, just cd into the vdjer directory and type `make`. An executable named
`vdjer` will be created.

To date, V'DJer has been tested only on linux systems.

Expand All @@ -33,14 +33,16 @@ V'DJer operates on paired end reads. Single end reads are not currently support
When mapping with STAR, unmapped reads must be included in the BAM file (this is not
STAR's default behavior). Include the unmapped reads using the following param:

```--outSAMunmapped Within```
`--outSAMunmapped Within`

Be sure to sort and index the BAM file.

The following runs vdjer on the input star.sort.bam file with vdj_contigs.fa
generated in the current working directory and read alignments written to vdjer.sam:

```vdjer --in star.sort.bam --t 8 --ins 175 --chain IGH --ref-dir vdjer_human_references/igh > vdjer.sam 2> vdjer.log```
```
vdjer --in star.sort.bam --t 8 --ins 175 --chain IGH --ref-dir vdjer_human_references/igh > vdjer.sam 2> vdjer.log
```

The above runs on the IgH chain with read length of 50, 8 threads and median insert length of 175.

Expand All @@ -59,8 +61,10 @@ In cases where a sample has low BCR expression levels, one may opt to run V'DJer
Running sensitive mode on samples with abundant BCR expression levels may result in extremely high computational costs.
Example command:

```vdjer --in star.sort.bam --t 8 --ins 175 --chain IGH --ref-dir vdjer_human_references/igh --k 25
--mq 60 --mf 2 --rs 25 --ms 2 --mcs -5.5 > vdjer.sam 2> vdjer.log ```
```
vdjer --in star.sort.bam --t 8 --ins 175 --chain IGH --ref-dir vdjer_human_references/igh --k 25
--mq 60 --mf 2 --rs 25 --ms 2 --mcs -5.5 > vdjer.sam 2> vdjer.log
```

Decreasing mq and mf from the defaults results in less aggressive graph pruning.
Reducing rs and ms results in less aggressive coverage based filtering
Expand Down