Displaying installed apps#

Apps perform functions ranging from multiple sequence alignment (e.g. progressive_align), to excluding alignment columns containing non-nucleotide characters (e.g. omit_degenerates) to performing maximum-likelihood evolutionary analyses (e.g. model).

from cogent3 import available_apps

available_apps()
packagenamecomposabledocinput typeoutput typelicenses
cogent3align_to_refTrueAligns sequences to a nominated reference in the unaligned collection.SequenceCollectionAlignment, ByteSequence, DictArray, DistanceMatrix, DnaSequence, PhyloNode, ProteinSequence, ProteinWithStopSequence, RnaSequence, Sequence, SequenceCollection, SerialisableType, Table, bootstrap_result, generic_result, hypothesis_result, model_result, tabular_resultBSD
cogent3ancestral_statesTrueComputes ancestral state probabilities from a model result.model_resultAlignment, ByteSequence, DictArray, DistanceMatrix, DnaSequence, PhyloNode, ProteinSequence, ProteinWithStopSequence, RnaSequence, Sequence, SequenceCollection, SerialisableType, Table, bootstrap_result, generic_result, hypothesis_result, model_result, tabular_resultBSD
cogent3approx_jc69TrueConverts p-distances and returns pairwise JC69 distancesDistanceMatrixDistanceMatrixBSD
cogent3approx_pdistTrueCalculates an approximation of the p-distance between sequences based on Jaccard distances (see Notes for details).DistanceMatrixDistanceMatrixBSD
cogent3bootstrapTrueParametric bootstrap for a provided hypothesis.AlignmentAlignment, ByteSequence, DictArray, DistanceMatrix, DnaSequence, PhyloNode, ProteinSequence, ProteinWithStopSequence, RnaSequence, Sequence, SequenceCollection, SerialisableType, Table, bootstrap_result, generic_result, hypothesis_result, model_result, tabular_resultBSD
.....................
piqtreepiq_jc_distancesTrueAlignmentDistanceMatrixGPL-2.0-only
piqtreepiq_model_finderTrueFind the models of best fit for an alignment using ModelFinder.AlignmentModelFinderResultGPL-2.0-only
piqtreepiq_nj_treeTrueConstruct a neighbour joining tree from a pairwise distance matrix.DistanceMatrixPhyloNodeGPL-2.0-only
piqtreepiq_random_treeTrueGenerate a random phylogenetic tree.intPhyloNodeGPL-2.0-only
piqtreepiq_simulate_alignmentTrueUses AliSim to simulate an Alignment through IQ-TREE.PhyloNodeAlignmentGPL-2.0-only

Top 5 and bottom 5 rows from 54 rows x 7 columns

The name_filter argument can be used to display only the apps that match a string. For example, to display all the loader apps

available_apps(name_filter="load")
packagenamecomposabledocinput typeoutput typelicenses
cogent3load_alignedTrueLoads aligned sequences. Returns an Alignment object.IdentifierTypeAlignment, ByteSequence, DictArray, DistanceMatrix, DnaSequence, PhyloNode, ProteinSequence, ProteinWithStopSequence, RnaSequence, Sequence, SequenceCollection, SerialisableType, Table, bootstrap_result, generic_result, hypothesis_result, model_result, tabular_resultBSD
cogent3load_dbTrueLoads serialised cogent3 objects from a db. Returns whatever object type was stored.IdentifierTypeAlignment, ByteSequence, DictArray, DistanceMatrix, DnaSequence, PhyloNode, ProteinSequence, ProteinWithStopSequence, RnaSequence, Sequence, SequenceCollection, SerialisableType, Table, bootstrap_result, generic_result, hypothesis_result, model_result, tabular_resultBSD
cogent3load_jsonTrueLoads json serialised cogent3 objects from a json file. Returns whatever object type was stored.IdentifierTypeAlignment, ByteSequence, DictArray, DistanceMatrix, DnaSequence, PhyloNode, ProteinSequence, ProteinWithStopSequence, RnaSequence, Sequence, SequenceCollection, SerialisableType, Table, bootstrap_result, generic_result, hypothesis_result, model_result, tabular_resultBSD
cogent3load_tabularTrueLoads delimited data. Returns a Table.IdentifierTypeDictArray, DistanceMatrix, TableBSD
cogent3load_unalignedTrueLoads unaligned sequences. Returns a SequenceCollection.IdentifierTypeAlignment, ByteSequence, DictArray, DistanceMatrix, DnaSequence, PhyloNode, ProteinSequence, ProteinWithStopSequence, RnaSequence, Sequence, SequenceCollection, SerialisableType, Table, bootstrap_result, generic_result, hypothesis_result, model_result, tabular_resultBSD

5 rows x 7 columns

Note

The first column lists the package providing the app.