-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
eb01bd2
commit 55a0fce
Showing
6 changed files
with
18 additions
and
132 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
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,6 +1,6 @@ | ||
# MitoHiFi | ||
|
||
------ This is v3.0.0 ------- | ||
------ This is v3.2 ------- | ||
|
||
MitoHiFi is a python pipeline distributed under the [MIT License](LICENSE) | ||
|
||
|
@@ -15,15 +15,15 @@ Find out more [Darwin Tree of Life data portal](https://portal.darwintreeoflife. | |
## 1. Background | ||
**MitoHiFi is a python workflow that assembles mitogenomes from Pacbio HiFi reads.** | ||
|
||
With MitoHiFi v3.0.0 you can start from the raw Pacbio HiFi reads (flag **-r**) or from the assembled contigs (flag **-c**). You also need a reference mitochondria sequence in FASTA and [GenBank format](https://www.ncbi.nlm.nih.gov/Sitemap/samplerecord.html). We provide an internal script (findMitoReference.py) that can be used to find and download the most closely-related reference genome for your species from NCBI. | ||
With MitoHiFi v3.2 you can start from the raw Pacbio HiFi reads (flag **-r**) or from the assembled contigs (flag **-c**). You also need a reference mitochondria sequence in FASTA and [GenBank format](https://www.ncbi.nlm.nih.gov/Sitemap/samplerecord.html). We provide an internal script (findMitoReference.py) that can be used to find and download the most closely-related reference genome for your species from NCBI. | ||
|
||
|
||
|
||
*The dissemination of high-quality long reads - such as PacBio HiFi - makes the assembly of high-quality mitogenome straightforward. Because of the circular nature of the molecule, however, the mitogenome is usually assembled redundantly resulting in multiple-copy mitogenome contigs. This pipeline was developed to finalise the assembly and annotate the mitogenome. It also considers heteroplasmy and aims to assemble and annotate all the mtDNA variants in your sample, among which MitoHiFi v2.2 will choose a representative as the final genome assembly according to the similarity to the reference genome and gene completeness. In addtion, an multiple sequence alignment (MSA) of all the variants is provided to facilitate the analysis of mitochondria heteroplasmy.* | ||
|
||
|
||
|
||
MitoHiFi v3.0.0 will: | ||
MitoHiFi v3.2 will: | ||
|
||
(i) extract mito reads and assemble them with hifiasm (flag **-r**), or find the mito contigs among assembled contigs (flag **-c**)<br /> | ||
|
||
|
@@ -39,7 +39,7 @@ MitoHiFi v3.0.0 will: | |
|
||
## 2. Installation | ||
|
||
There are two ways to install MitoHiFi v3.0.0: | ||
There are two ways to install MitoHiFi v3.2: | ||
|
||
(i) manually - and then you will need to have all the dependencies installed in your PATH. | ||
|
||
|
@@ -80,18 +80,18 @@ export PATH=</path/to/MitoFinder>:${PATH} | |
|
||
where `</path/to/MitoFinder>` needs to be replaced with the path where MitoFinder was installed. | ||
|
||
**Once all dependencies are installed, install MitoHiFi v2.3 (Linux)** | ||
**Once all dependencies are installed, install MitoHiFi v3.2 (Linux)** | ||
|
||
``` | ||
git clone https://github.com/marcelauliano/MitoHiFi.git | ||
``` | ||
|
||
### 2.2 Running MitoHiFi v3.0.0 from a Singularity with a Docker image | ||
### 2.2 Running MitoHiFi v3.2 from a Singularity with a Docker image | ||
|
||
|
||
We have wrapped up MitoHiFi v3.0.0 code into a singularity container. We recommend using singularity versions => 3.7, as lower versions do not support spaces in the arguments, and you would not be able to pass more than one set of reads to the flag **-r** | ||
We have wrapped up MitoHiFi v3.2 code into a singularity container. We recommend using singularity versions => 3.7, as lower versions do not support spaces in the arguments, and you would not be able to pass more than one set of reads to the flag **-r** | ||
|
||
MitoHiFi.v3.0.0 siungularity image should be run as: | ||
MitoHiFi.v3.2 siungularity image should be run as: | ||
|
||
``` | ||
singularity exec --bind /lustre/:/lustre/ docker://ghcr.io/marcelauliano/mitohifi:master mitohifi.py -r "/data/f1.fasta /data/f2.fasta /data/f3.fasta" -f /data/reference.fasta -g /data/reference.gb -t 10 -o 2 | ||
|
@@ -301,4 +301,4 @@ And for tRNAs annotation: | |
|
||
For more information on python code and pipeline: [email protected] and [email protected] | ||
|
||
Questions on the Singularity: Marcela Uliano [email protected] | ||
Questions about the Docker container: Marcela Uliano-Silva [email protected] |
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
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