Skip to content

Commit

Permalink
docs: fix CLI usage in examples (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
clintval authored Jul 26, 2024
1 parent 67e5da9 commit 46022f2
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,20 +37,20 @@ Although paired-end reads will give the most discriminatory power for disambigua
- Will disambiguate an arbitrary number of BAMs, all aligned to different references
- Writes the ambiguous alignments to a separate directory
- Extensible implementation which supports alternative disambiguation strategies
- Benchmarks show high accuracy: [Click Here](benchmarks/disambiguate.md)
- Benchmarks show high accuracy: [Click Here](benchmarks/README.md)

### Command Line Usage

```bash
❯ neodisambiguate -i infile1.bam infile2.bam -p out/disambiguated
❯ neodisambiguate -i infile1.bam infile2.bam -o out/disambiguated
```

### Example Usage

To disambiguate templates for sample `dna00001` that are aligned to human (A) and mouse (B):

```bash
❯ neodisambiguate -i dna00001.A.bam dna00001.B.bam -p out/dna00001 -n hg38 mm10
❯ neodisambiguate -i dna00001.A.bam dna00001.B.bam -o out/dna00001 -n hg38 mm10
```

```console
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ object Disambiguate {
|To disambiguate a sample aligned to human (A) and mouse (B):
|
|```
|❯ neodisambiguate -i dna00001.A.bam dna00001.B.bam -p out/dna00001 -n hg38 mm10
|❯ neodisambiguate -i dna00001.A.bam dna00001.B.bam -o out/dna00001 -n hg38 mm10
|
|❯ tree out/
| out/
Expand Down

0 comments on commit 46022f2

Please sign in to comment.