Skip to content

Commit

Permalink
typos
Browse files Browse the repository at this point in the history
  • Loading branch information
mikolmogorov committed Aug 21, 2021
1 parent c6d3d2e commit f6ec19e
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 12 deletions.
7 changes: 3 additions & 4 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ many human assemblies, which typically require ~450Gb of RAM for ONT and ~140Gb
Memory consumption grows linearly with genome size and reads coverage.
Thus, genomes beyond ~10Gb is size might be problemmatic to assmeble.

Typically, memory requirements are lower for higher quality data (e.g. PacBio HiFi or ONT Hq mode).
Typically, memory requirements are lower for higher quality data (e.g. PacBio HiFi or ONT HQ mode).

Are PacBio CCS/HiFi reads supported?
-------------------------------
Expand Down Expand Up @@ -175,13 +175,12 @@ Do I still need Illumina polishing or long-read polishing is good enough?

It is a somewhat difficult question to answer. Flye does include
polishing step, and it producing high quality consensus on bacterial
PacBio datasets with high coverage. For example, see this recent
PacBio CLR datasets with high coverage. For example, see this recent
[evaluation by Ryan Wick](https://github.com/rrwick/Long-read-assembler-comparison).
On the other hand, PacBio has specialized Quiver/Arrow tools that
are more advanced, since they use PacBio-specific signal information.
It is possible, that you can get a bit of improvement after applying these tools.

For the recent ONT data (Guppy4+), Flye often achieves Q30+ quality on verious genomes.
For the recent ONT data (Guppy4+), Flye often achieves Q30+ quality on various genomes.
One can typically push that a bit higher using Medaka or Nanopolish. See
the recent [Trycycler paper and tool](https://github.com/rrwick/Trycycler) for the discussion.

Expand Down
12 changes: 6 additions & 6 deletions docs/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,20 +77,20 @@ optional arguments:

Input reads can be in FASTA or FASTQ format, uncompressed
or compressed with gz. Currently, PacBio (CLR, HiFi, corrected)
and ONT reads (raw, HQ, corrected) are supported. Expected error rates are
<20% for CLR/raw ONT, <5% for ONT HQ, <3% for corrected, and <1% for HiFi. Note that Flye
and ONT reads (regular, HQ, corrected) are supported. Expected error rates are
<20% for PB CLR/regular ONT, <5% for ONT HQ, <3% for corrected, and <1% for HiFi. Note that Flye
was primarily developed to run on uncorrected reads. You may specify multiple
files with reads (separated by spaces). Mixing different read
types is not yet supported. The --meta option enables the mode
types is not yet supported. The `--meta` option enables the mode
for metagenome/uneven coverage assembly.

To reduce memory consumption for large genome assemblies,
you can use a subset of the longest reads for initial disjointig
assembly by specifying --asm-coverage and --genome-size options. Typically,
assembly by specifying `--asm-coverage` and `--genome-size` options. Typically,
40x coverage is enough to produce good disjointigs.

You can run Flye polisher as a standalone tool using
--polish-target option.
`--polish-target` option.

## <a name="examples"></a> Examples

Expand Down Expand Up @@ -238,7 +238,7 @@ all reads will be used at the later pipeline stages (e.g. for repeat resolution)
### Running only Flye polisher

To polish an existing assembly, you can run Flye polisher as a standalone tool
using --polish-target. Paths to reads are specified similarly to the assembly mode,
using `--polish-target`. Paths to reads are specified similarly to the assembly mode,
and bam file could also be proveded instead of reads (the mapping stage in this case will
be skipped).

Expand Down
4 changes: 2 additions & 2 deletions flye/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -625,8 +625,8 @@ def _usage():
def _epilog():
return ("Input reads can be in FASTA or FASTQ format, uncompressed\n"
"or compressed with gz. Currently, PacBio (CLR, HiFi, corrected)\n"
"and ONT reads (raw, HQ, corrected) are supported. Expected error rates are\n"
"<20% for CLR/raw ONT, <5% for ONT HQ, <3% for corrected, and <1% for HiFi. Note that Flye\n"
"and ONT reads (regular, HQ, corrected) are supported. Expected error rates are\n"
"<15% for PB CLR/regular ONT; <5% for ONT HQ, <3% for corrected, and <1% for HiFi. Note that Flye\n"
"was primarily developed to run on uncorrected reads. You may specify multiple\n"
"files with reads (separated by spaces). Mixing different read\n"
"types is not yet supported. The --meta option enables the mode\n"
Expand Down

0 comments on commit f6ec19e

Please sign in to comment.