-
Notifications
You must be signed in to change notification settings - Fork 126
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update README and Dockerfile Racon-minimap2
- Loading branch information
1 parent
6dae658
commit 91fe523
Showing
3 changed files
with
66 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Racon + Minimap2 Container | ||
|
||
This container combines [Racon](https://github.com/lbcb-sci/racon) and [Minimap2](https://github.com/lh3/minimap2) for efficient polishing and alignment in long-read assembly workflows. | ||
|
||
## Tools Included | ||
- **Racon**: Polishes long-read assemblies. | ||
- **Minimap2**: Generates alignments for use with Racon and other polishing tools. | ||
|
||
### Code Repositories | ||
- Racon: [GitHub Repository](https://github.com/lbcb-sci/racon) | ||
- Minimap2: [GitHub Repository](https://github.com/lh3/minimap2) | ||
|
||
## Basic Information | ||
|
||
### Racon | ||
- **Executable**: `racon` | ||
- **Help**: `racon -h` | ||
- **Version**: `racon -v` | ||
- **Description**: | ||
> Racon is intended as a standalone consensus module to correct raw contigs generated by rapid assembly methods that do not include a consensus step. | ||
### Minimap2 | ||
- **Executable**: `minimap2` | ||
- **Help**: `minimap2 -h` | ||
- **Version**: `minimap2 --version` | ||
- **Description**: | ||
> Minimap2 is a versatile sequence alignment program that aligns DNA or mRNA sequences against a large reference database. | ||
## Example Usage | ||
|
||
```bash | ||
# Racon general | ||
racon <sequences> <overlaps> <target sequences> | ||
|
||
# more specific | ||
racon --match 8 --mismatch -6 --gap -8 --window-length 500 --threads {threads} {input.reads} {input.alignment} {input.assembly} | ||
|
||
#Combined Racon and Minimap2 Workflow | ||
|
||
#Align Reads to Assembly Using Minimap2: | ||
minimap2 -x map-ont <assembly.fasta> <reads.fastq> > overlaps.paf | ||
|
||
#polish assembly using Racon | ||
racon --threads {threads} <reads.fastq> overlaps.paf <assembly.fasta> > polished_assembly.fasta | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,46 +1,23 @@ | ||
# Racon + Minimap2 Container | ||
# racon container | ||
|
||
This container combines [Racon](https://github.com/lbcb-sci/racon) and [Minimap2](https://github.com/lh3/minimap2) for efficient polishing and alignment in long-read assembly workflows. | ||
Main tool : [racon](https://github.com/lbcb-sci/racon) | ||
|
||
## Tools Included | ||
- **Racon**: Polishes long-read assemblies. | ||
- **Minimap2**: Generates alignments for use with Racon and other polishing tools. | ||
Code repository: https://github.com/lbcb-sci/racon | ||
|
||
### Code Repositories | ||
- Racon: [GitHub Repository](https://github.com/lbcb-sci/racon) | ||
- Minimap2: [GitHub Repository](https://github.com/lh3/minimap2) | ||
Basic information on how to use this tool: | ||
- executable: racon | ||
- help: -h | ||
- version: -v | ||
- description: Polishes long read assemblies | ||
|
||
## Basic Information | ||
> Racon is intended as a standalone consensus module to correct raw contigs generated by rapid assembly methods which do not include a consensus step. | ||
### Racon | ||
- **Executable**: `racon` | ||
- **Help**: `racon -h` | ||
- **Version**: `racon -v` | ||
- **Description**: | ||
> Racon is intended as a standalone consensus module to correct raw contigs generated by rapid assembly methods that do not include a consensus step. | ||
### Minimap2 | ||
- **Executable**: `minimap2` | ||
- **Help**: `minimap2 -h` | ||
- **Version**: `minimap2 --version` | ||
- **Description**: | ||
> Minimap2 is a versatile sequence alignment program that aligns DNA or mRNA sequences against a large reference database. | ||
## Example Usage | ||
# Example Usage | ||
|
||
```bash | ||
# Racon general | ||
# general | ||
racon <sequences> <overlaps> <target sequences> | ||
|
||
# more specific | ||
racon --match 8 --mismatch -6 --gap -8 --window-length 500 --threads {threads} {input.reads} {input.alignment} {input.assembly} | ||
|
||
#Combined Racon and Minimap2 Workflow | ||
|
||
#Align Reads to Assembly Using Minimap2: | ||
minimap2 -x map-ont <assembly.fasta> <reads.fastq> > overlaps.paf | ||
|
||
#polish assembly using Racon | ||
racon --threads {threads} <reads.fastq> overlaps.paf <assembly.fasta> > polished_assembly.fasta | ||
``` | ||
|
||
``` |