Fork me on GitHub

midpoint-root: Midpoint root an unrooted phylogenetic tree.ΒΆ

Docstring:

Usage: qiime phylogeny midpoint-root [OPTIONS]

  Midpoint root an unrooted phylogenetic tree.

Options:
  --i-tree ARTIFACT PATH Phylogeny[Unrooted]
                                  The phylogenetic tree to be rooted.
                                  [required]
  --o-rooted-tree ARTIFACT PATH Phylogeny[Rooted]
                                  The rooted phylogenetic tree.  [required if
                                  not passing --output-dir]
  --output-dir DIRECTORY          Output unspecified results to a directory
  --cmd-config FILE               Use config file for command options
  --verbose                       Display verbose output to stdout and/or
                                  stderr during execution of this action.
                                  [default: False]
  --quiet                         Silence output if execution is successful
                                  (silence is golden).  [default: False]
  --citations                     Show citations and exit.
  --help                          Show this message and exit.

Import:

from qiime2.plugins.phylogeny.methods import midpoint_root

Docstring:

Midpoint root an unrooted phylogenetic tree.

Midpoint root an unrooted phylogenetic tree.

Parameters
----------
tree : Phylogeny[Unrooted]
    The phylogenetic tree to be rooted.

Returns
-------
rooted_tree : Phylogeny[Rooted]
    The rooted phylogenetic tree.