Skip to content

Commit

Permalink
updates usage
Browse files Browse the repository at this point in the history
  • Loading branch information
brwnj committed Sep 9, 2021
1 parent c5ada5f commit 4410016
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ expandsions from short-read data.

# Usage

To run joint calls across more than one sample on version 1.0 of the workflow:
To run joint calls across more than one sample on the `main` branch of the workflow:

```
nextflow run quinlan-lab/STRling-nf -r 1.0 \
nextflow run quinlan-lab/STRling-nf -r main \
--joint --crams 'preprocessing/*.bam' --reference GRCh38.fasta \
```

Alternately, `-r` can designate tags, e.g. `-r v1.0.1`.

The workflow expects the alignments to be indexed (contain a .bai/.crai)
in the same directory as the .bam/.cram. It also expects the reference
.fasta to be indexed (.fai) and be in the same directory as the .fasta.
Expand Down

0 comments on commit 4410016

Please sign in to comment.