taxonGuidetree-class: Class "taxonGuidetree"
In heibl/megaptera: MEGAPhylogeny Techniques in R

Description Objects from the Class Slots Methods Author(s) See Also

Class for taxonomic input parameters for megapteraProj.

Objects can be created by calls of the form taxonGuidetree(ingroup, extend.ingroup, outgroup, extend.outgroup, kingdom, exclude.hybrids = FALSE, tip.rank, reference.rank = "auto", guide.tree).

ingroup: a list of vectors of mode "character", giving species names (Linnean binomials) or names of higher taxa that define the focal group. Linnean binomials and taxon names of higher rank must not be mixed in the same list. If the elements of the list are vectors of length greater than one, the first element of the vector is taken as the accepted name and the remaining are treated as synonyms. Synonyms are used in the search for sequences, but any results are stored in the database under the accepted name.
outgroup: a list of vectors of mode "character", giving species names (Linnean binomials) or names of higher taxa that define the outgroup. Linnean binomials and taxon names of higher rank must not be mixed in the same list. If the elements of the list are vectors of length greater than one, the first element of the vector is taken as the accepted name and the remaining are treated as synonyms. Synonyms are used in the search for sequences, but any results are stored in the database under the accepted name.
kingdom: a vector of mode "character", currently one of "Fungi", "Metazoa", or "Viridiplantae". The International Code of Nomenclature for algae, fungi, and plants (ICN) and the International Code of Zoological Nomenclature (ICZN) do not exclude the possibility that genera and species of plants/fungi/algae and animals share the same name (e.g., Prunella vulgaris). Therefore it is necessary to include the kingdom into the search term when querying GenBank.
exclude.hybrids: logical: if TRUE, hybrids (as recognized by the regular expression "^x_|_x_") will be excluded from the pipeline.
reference.rank: a vector of mode "character", giving the name of the rank to be used to create subsets of the sequences to derive the reference sequence(s). The default ("auto") commits the selection of the reference rank to the pipeline and in most cases you should be fine using this option.
guide.tree: an object of class phylo giving a user guide tree, which will be used for profile alignment.

show: signature(object = "taxonGuidetree"): prints taxonomic parameter setting

Christoph Heibl

dbPars, locus, and megapteraPars for defining of database parameters, loci, and the pipeline's parameters, respectively, and megapteraProj for the bundling of input data.

heibl/megaptera documentation built on Jan. 17, 2021, 3:34 a.m.