skbio.tree.TreeNode.shear

TreeNode.shear(names)[source]

Lop off tips until the tree just has the desired tip names.

State: Experimental as of 0.4.0.

Parameters

names (Iterable of str) – The tip names on the tree to keep

Returns

The resulting tree

Return type

TreeNode

Raises

ValueError – If the names do not exist in the tree

Examples

>>> from skbio import TreeNode
>>> t = TreeNode.read(['((H:1,G:1):2,(R:0.5,M:0.7):3);'])
>>> sheared = t.shear(['G', 'M'])
>>> print(sheared)
(G:3.0,M:3.7);