GeMoRNA
Tools
GeMoRNA
GeMoRNA may be called with
java -jar GeMoRNA-1.0.jar gemorna
and has the following parameters
name | comment | type |
g | Genome (Genome sequence as FastA, type = fa,fna,fasta) | FILE |
m | Mapped reads (Mapped Reads in BAM format, coordinate sorted, type = bam) | FILE |
s | Stranded (Library strandedness, range={FR_UNSTRANDED, FR_FIRST_STRAND, FR_SECOND_STRAND}, default = FR_UNSTRANDED) | STRING |
l | Longest intron length (Length of the longest intron reported, default = 100000) | INT |
sil | Shortest intron length (Length of the shortest intron considered, default = 10) | INT |
lr | Long reads (Long-read mode, default = false) | BOOLEAN |
mnor | Minimum number of reads (Minimum number of reads required for an edge in the read graph, default = 1.0) | DOUBLE |
mfor | Minimum fraction of reads (Minimum fraction of reads relative to adjacent exons that must support an intron in the enumeration, default = 0.01) | DOUBLE |
mnoir | Minimum number of intron reads (Minimum number of reads required for an intron, default = 1.0) | DOUBLE |
mfoir | Minimum fraction of intron reads (Minimum fraction of reads relative to adjacent exons for an intron to be considered, default = 0.01) | DOUBLE |
p | Percent explained (Percent of abundance that must be explained by transcript models after quantification, default = 0.9) | DOUBLE |
mrpg | Minimum reads per gene (Minimum abundance required for a gene to be reported, default = 40.0) | DOUBLE |
mrpt | Minimum reads per transcript (Minimum abundance required for a transcript to be reported, default = 20.0) | DOUBLE |
pa | Percent abundance (Minimum relative abundance required for a transcript to be reported, default = 0.05) | DOUBLE |
sf | Successive fraction (Factor of the drop in abundance between successive transcript models, default = 20.0) | DOUBLE |
mrl | Maximum region length (Maximum length of a region considered before it is split, default = 750000) | INT |
mfgl | Maximum filled gap length (Maximum length of a gap filled by dummy reads, default = 50) | INT |
q | Quality filter (Minimum mapping quality required for a read to be considered, default = 40) | INT |
mpl | Minimum protein length (Minimum length of protein in AA, default = 70) | INT |
outdir | The output directory, defaults to the current working directory (.) | STRING |
threads | The number of threads used for the tool, defaults to 1 | INT |
Example:
java -jar GeMoRNA-1.0.jar gemorna g=<Genome> m=<Mapped_reads>
Predict CDS from GFF
Predict CDS from GFF may be called with
java -jar GeMoRNA-1.0.jar predictCDS
and has the following parameters
name | comment | type |
g | Genome (Genome sequence as FastA, type = fa,fna.fasta) | FILE |
p | predicted annotation ("GFF or GTF file containing the predicted annotation", type = gff,gff3,gff.gz,gff3.gz,gtf,gtf.gz) | FILE |
m | Minimum protein length (Minimum length of protein in AA, default = 70) | INT |
outdir | The output directory, defaults to the current working directory (.) | STRING |
Example:
java -jar GeMoRNA-1.0.jar predictCDS g=<Genome> p=<predicted_annotation>
GeMoMa Annotation Filter
This tool combines and filters gene predictions from different sources yielding a common gene prediction. The tool does not modify the predictions, but filters redundant and low-quality predictions and selects relevant predictions. In addition, it adds attributes to the annotation of transcript predictions.
The algorithm does the following: First, redundant predictions are identified (and additional attributes (evidence, sumWeight) are introduced). Second, the predictions are filtered using the user-specified criterium based on the attributes from the annotation. Third, clusters of overlapping predictions are determined, the predictions are sorted within the cluster and relevant predictions are extracted.
Optionally, annotation info can be added for each reference organism enabling a functional prediction for predicted transcripts based on the function of the reference transcript. Phytozome provides annotation info tables for plants, but annotation info can be used from any source as long as they are tab-delimited files with at least the following columns: transcriptName, GO and .*defline.
Initially, GAF was build to combine gene predictions obtained from GeMoMa. It allows to combine the predictions from multiple reference organisms, but works also using only one reference organism. However, GAF also allows to integrate predictions from ab-initio or purely RNA-seq-based gene predictors as well as manually curated annotation. If you like to do so, we recommend to run AnnotationEvidence for each of these input files to add additional attributes that can be used for sorting and filtering within GAF. The sort and filter criteria need to be carefully revised in this case. Default values can be set for missing attributes.
For more information please visit http://www.jstacs.de/index.php/GeMoMa If you have any questions, comments or bugs, please check FAQs on our homepage, our github page https://github.com/Jstacs/Jstacs/labels/GeMoMa or contact jens.keilwagen@julius-kuehn.de
GeMoMa Annotation Filter may be called with
java -jar GeMoRNA-1.0.jar GAF
and has the following parameters
name | comment | type | |||||||||||||||||||||||||||||||||
t | tag (the tag used to read the GeMoMa annotations, default = mRNA) | STRING | |||||||||||||||||||||||||||||||||
The following parameter(s) can be used multiple times: | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
d | default attributes (Comma-separated list of attributes that is set to NaN if they are not given in the annotation file. This allows to use these attributes for sorting or filter criteria. It is especially meaningful if the gene annotation files were received fom different software packages (e.g., GeMoMa, Braker, ...) having different attributes., default = tie,tde,tae,iAA,pAA,score,lpm,maxGap,bestScore,maxScore,raa,rce) | STRING | |||||||||||||||||||||||||||||||||
k | kmeans (whether kmeans should be performed for each input file and clusters with large mean distance to the origin will be discarded, range={NO, YES}, default = NO) | STRING | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
f | filter (A filter can be applied to transcript predictions to receive only reasonable predictions. The filter is applied to the GFF attributes. The default filter decides based on the completeness of the prediction (start=='M' and stop=='*') and the relative score (score/aa>=0.75) whether a prediction is used or not. In addition, predictions without score (isNaN(score)) will be used as external annotations do not have the attribute score. Different criteria can be combined using 'and' and 'or'. A more sophisticated filter could be applied for instance using the completeness, the relative score, the evidence as well as statistics based on RNA-seq: start=='M' and stop=='*' and score/aa>=0.75 and (evidence>1 or tpc==1.0), default = start=='M' and stop=='*' and (isNaN(score) or score/aa>=0.75), OPTIONAL) | STRING | |||||||||||||||||||||||||||||||||
s | sorting (comma-separated list that defines the way predictions are sorted within a cluster, default = sumWeight,score,aa) | STRING | |||||||||||||||||||||||||||||||||
i | intermediate result (a switch to decide whether an intermediate result of filtered predictions that are not combined to genes should be returned, default = false) | BOOLEAN | |||||||||||||||||||||||||||||||||
l | length difference (maximal percentage of length difference between the representative transcript and an alternative transcript, alternative transcripts with a higher percentage are discarded, valid range = [0.0, 10000.0], OPTIONAL) | DOUBLE | |||||||||||||||||||||||||||||||||
atf | alternative transcript filter (If a prediction is suggested as an alternative transcript, this additional filter will be applied. The filter works syntactically like the 'filter' parameter and allows you to keep the number of alternative transcripts small based on meaningful criteria. Reasonable filter could be based on RNA-seq data (tie==1) or on sumWeight (sumWeight>1). A more sophisticated filter could be applied combining several criteria: tie==1 or sumWeight>1, default = tie==1 or sumWeight>1, OPTIONAL) | STRING | |||||||||||||||||||||||||||||||||
cbf | common border filter (the filter on the common borders of transcripts, the lower the more transcripts will be checked as alternative splice isoforms, valid range = [0.0, 1.0], default = 0.75) | DOUBLE | |||||||||||||||||||||||||||||||||
mnotpg | maximal number of transcripts per gene (the maximal number of allowed transcript predictions per gene, valid range = [1, 2147483647], default = 2147483647) | INT | |||||||||||||||||||||||||||||||||
aat | add alternative transcripts (a switch to decide whether the IDs of alternative transcripts that have the same CDS should be listed for each prediction, default = false) | BOOLEAN | |||||||||||||||||||||||||||||||||
tf | transfer features (if true, additional features like UTRs will be transfered from the input to the output. Only features of the representatives will be transfered. The UTRs of identical CDS predictions listed in "alternative" will not be transfered or combined, default = false) | BOOLEAN | |||||||||||||||||||||||||||||||||
outdir | The output directory, defaults to the current working directory (.) | STRING |
Example:
java -jar GeMoRNA-1.0.jar GAF g=<gene_annotation_file>
Analyzer
This tools allows to compare true annotation with predicted annotation as it is frequently done in benchmark studies. Furthermore, it can return a detailed table comparing true annotation and predicted annotation which might help to identify systematical errors or biases in the predictions. Hence, this tool might help to detect weaknesses of the prediction algorithm.
True and predicted transcripts are evaluated based on nucleotide F1 measure. For each predicted transcript, the true transcript with highest nucleotide F1 measure is listed. A negative value in a F1 measure column indicates that there is a predicted transcript that matches the true transcript with a F1 measure value that is the absolute value of this entry, but there is another true transcript that matches this predicted transcript with an even better F1. Also true and predicted transcripts are listed that do not overlap with any transcript from the predicted and true annotation, respectively. The table contains the attributes of the true and the predicted annotation besides some additional columns allowing to easily filter interesting examples and to do statistics.
The evaluation can be based on CDS (default) or exon features. The tool also reports sensitivity and precision for the categories gene and transcript.
For more information please visit http://www.jstacs.de/index.php/GeMoMa If you have any questions, comments or bugs, please check FAQs on our homepage, our github page https://github.com/Jstacs/Jstacs/labels/GeMoMa or contact jens.keilwagen@julius-kuehn.de
Analyzer may be called with
java -jar GeMoRNA-1.0.jar Analyzer
and has the following parameters
name | comment | type | |||||||||
t | truth (the true annotation, type = gff,gff3,gtf,gff.gz,gff3.gz,gtf.gz) | FILE | |||||||||
The following parameter(s) can be used multiple times: | |||||||||||
| |||||||||||
c | CDS (if true CDS features are used otherwise exon features, default = true) | BOOLEAN | |||||||||
o | only introns (if true only intron borders (=splice sites) are evaluated, default = false) | BOOLEAN | |||||||||
w | write (write detailed table comparing the true and the predicted annotation, range={NO, YES}, default = NO) | STRING | |||||||||
| |||||||||||
r | reliable (additionally evaluate sensitivity for reliable transcripts, range={NO, YES}, default = NO) | STRING | |||||||||
| |||||||||||
outdir | The output directory, defaults to the current working directory (.) | STRING |
Example:
java -jar GeMoRNA-1.0.jar Analyzer t=<truth> p=<predicted_annotation>
Merge
Merge may be called with
java -jar GeMoRNA-1.0.jar merge
and has the following parameters
name | comment | type | ||||||||||||||||||||||||
g | GeMoMa (GeMoMa predictions, type = gff,gff3) | FILE | ||||||||||||||||||||||||
GeMoRNA | GeMoRNA (GeMoRNA predictions, type = gff,gff3) | FILE | ||||||||||||||||||||||||
m | Mode (, range={intersect, union, intermediate, annotate}, default = intersect) | STRING | ||||||||||||||||||||||||
| ||||||||||||||||||||||||||
outdir | The output directory, defaults to the current working directory (.) | STRING |
Example:
java -jar GeMoRNA-1.0.jar merge g=<GeMoMa> GeMoRNA=<GeMoRNA>