skbio.tree.TreeNode.write#

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

Write an instance of TreeNode to a file.

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

Supported file formats include:

Parameters:
fileopenable (filepath, filehandle, etc.)

The location to write 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 to write the TreeNode object as. The format must be a registered format name with a writer for TreeNode. Default is 'newick'.

kwargsdict, optional

Additional arguments passed to the writer for TreeNode.