skbio.tree.TreeNode.read#

TreeNode.read(format=None, **kwargs)[source]#

Create a new TreeNode instance from a file.

This is a convenience method for skbio.io.registry.read(). For more information about the I/O system in scikit-bio, please see skbio.io.

Supported file formats include:

Parameters:

fileopenable (filepath, URL, filehandle, etc.): The location to read the given format into. Something that is understood by skbio.io.util.open(). Filehandles are not automatically closed, it is the responsibility of the caller.
formatstr, optional: The format of the file. The format must be a format name with a reader for TreeNode. If None, the format will be inferred.
kwargsdict, optional: Additional arguments passed to skbio.io.registry.read() and the reader for TreeNode.

Returns: