metaeuk {bifrost} R Documentation

MetaEuk: the homology based eukaryotic gene prediction

Description

Usage

metaeuk(x);

Arguments

x

a metaeuk_config object(MetaEukConfig) that carries all of the required data and parameters for run the metaeuk gene prediction: the contigs assembly fasta file path(ContigsFile), the reference protein fasta file path(ReferenceFile), the output file prefix(OutputPrefix

env

[as Environment]

Details

Unlike the prodigal gene prediction, which is running in an ab-initio manner, the metaeuk algorithm is running in a reference protein database dependent manner: at first the contigs assembly sequence is translated in six reading frames for generate the candidate coding fragments, and then the candidate fragments are aligned to the reference protein database for get the homology hits, at last the optimal exon set of each gene is picked out from the homology hits via dynamic programming.

NOTE: the input argument is evaluated as a fasta sequence collection at first in the current implementation, so that a metaeuk_config object input will be rejected by the sequence data check with the error message "there is no MAGs contigs assembly sequence input!", please run this metaeuk gene prediction program from the commandline at this moment.

Authors

seqtoolkit

Value

a collection of the gene prediction result: each element in the collection(GenePrediction) is a predicted gene that its exons are chained from the homology hits of the reference protein database.

this function returns a R# error message object if the input config object is nothing, or the required contigs/reference file is not specified in the config object.

clr value class

Examples


[Package bifrost version 1.0.0.0 Index]