Skip to content

Commit ea903e5

Browse files
authored
Update README.md
1 parent 4db9f03 commit ea903e5

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ A **gene call** is an optimal set of exons predicted based on similarity to a sp
3131
## Running MetaEuk
3232
### Main Modules:
3333

34+
easy-predict Predict proteins from contigs (fasta/db) based on similarities to targets (fasta/db) and return a fasta
3435
predictexons Call optimal exon sets based on protein similarity
3536
reduceredundancy Cluster metaeuk calls which share an exon and select representative
3637
unitesetstofasta Create a fasta output from optimal exon sets
3738
groupstoacc Create a TSV output from representative to calls
38-
easy-predict Predict proteins from contigs (fasta/db) based on similarities to targets (fasta/db) and return a fasta
3939

4040

4141
### Important parameters:
@@ -47,6 +47,13 @@ A **gene call** is an optimal set of exons predicted based on similarity to a sp
4747
--slice-search if refernceDB is a profile database, should be added
4848
4949

50+
### easy-predict workflow:
51+
52+
This workflow combines the following MetaEuk modules into a single step: predictexons, reduceredundancy and unitesetstofasta (each of which is detailed below). Its input are contigs (either as a Fasta file or a previously created database) and targets (either as a Fasta file of protein sequences or a previously created database of proteins or protein profiles). It will run the modules and output the predictions in Fasta foramt.
53+
54+
metaeuk easy-predict contigsFasta/contigsDB proteinsFasta/referenceDB predsResultProteins.fas tempFolder
55+
56+
5057
### Calling optimal exons sets:
5158

5259
This module will extract all putative protein fragments from each contig and strand, query them against the reference targets and use dynamic programming to retain for each **T** the optimal compatible exon set from each **C** & **S** (thus creating **TCS** calls).
@@ -102,12 +109,6 @@ can help mapping from each representative prediction after the redundancy reduct
102109
metaeuk groupstoacc contigsDB referenceDB predGroupsDB predGroups.tsv
103110

104111

105-
### easy-predict workflow:
106-
107-
This workflow combines the following MetaEuk modules into a single step: predictexons, reduceredundancy and unitesetstofasta. Its input are contigs (either as a Fasta file or a previously created database) and targets (either as a Fasta file of protein sequences or a previously created database of proteins or protein profiles). It will run the modules and output the predictions in Fasta foramt.
108-
109-
metaeuk easy-predict contigsFasta/contigsDB proteinsFasta/referenceDB predsResultProteins.fas tempFolder
110-
111112

112113
## Compile from source
113114
Compiling MetaEuk from source has the advantage that it will be optimized to the specific system, which should improve its performance. To compile MetaEuk `git`, `g++` (4.6 or higher) and `cmake` (3.0 or higher) are required. Afterwards, the MetaEuk binary will be located in the `build/bin` directory.

0 commit comments

Comments
 (0)