skbio.tree.BPTree.write

BPTree.write(file, format=None, **kwargs)

Write an instance of BPTree 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:

• 'newick' (skbio.io.format.newick)

• 'jplace' (skbio.io.format.jplace)

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

kwargsdict, optional

Additional arguments passed to the writer for BPTree.

See also

read

skbio.io.registry.write

skbio.io.util.open

skbio.io.format.newick

skbio.io.format.jplace