Skip to content

Commit 28e3975

Browse files
lcoombeaafshinfard
andauthored
Corrections to README (#166)
* Update README.md * Update README.md Co-authored-by: Amirhossein Afshinfard <31241012+afshinfard@users.noreply.github.com>
1 parent bad1a0c commit 28e3975

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,21 +45,21 @@ cd physlr/src && make install PREFIX=/opt/physlr
4545
## Generating Physlr Physical Map with stLFR reads
4646

4747
To construct a physical map, you need linked reads from 10X Genomics or stLFR. In addition, to visualize the correctness and contiguity of the physical map, you need a reference genome.
48-
In this example, the linked reads and reference genome are called `linkedreads.fq.gz` and `reference.fa`, respectively. The linked reads are from stLFR so we specify `minimizer_overlap=stLFR` to use the default value for stLFR reads.
48+
In this example, the linked reads and reference genome are called `linkedreads.fq.gz` and `reference.fa`, respectively. The linked reads are from stLFR so we specify `protocol=stlfr` to use the default value for stLFR reads.
4949

5050
```
5151
cd experiment
52-
bin/physlr-make physical-map lr=linkedreads ref=reference minimizer_overlap=stLFR
52+
bin/physlr-make physical-map lr=linkedreads ref=reference protocol=stlfr
5353
```
5454

5555
## Scaffolding a draft assembly with Physlr Physical Map
5656

5757
To scaffold a draft assembly, you need linked reads from 10X Genomics or stLFR, and an existing assembly. In addition, to calculate Quast summary metrics for the Physlr scaffolded assembly, you need a reference genome.
58-
In this example, the linked reads, draft assembly, and reference genome are called `linkedreads.fq.gz`, `draft.fa`, `reference.fa`, respectively. The linked reads are from 10X Genomics so we specify `minimizer_overlap=10X` to use the default value for 10X Genomics reads.
58+
In this example, the linked reads, draft assembly, and reference genome are called `linkedreads.fq.gz`, `draft.fa`, `reference.fa`, respectively. The linked reads are from 10X Genomics so we specify `protocol=10x` to use the default value for 10X Genomics reads.
5959

6060
```
6161
cd experiment
62-
bin/physlr-make scaffolds lr=linkedreads ref=reference draft=draft minimizer_overlap=10X
62+
bin/physlr-make scaffolds lr=linkedreads ref=reference draft=draft protocol=10x
6363
```
6464

6565
See the help page for further information.

0 commit comments

Comments
 (0)