load_tree¶
- load_tree(filename: Union[str, Path], format=None, underscore_unmunge=False)¶
Constructor for tree.
- Parameters:
filename (str) – a file path containing a newick or xml formatted tree.
format (str) – either xml or json, all other values default to newick. Overrides file name suffix.
underscore_unmunge (bool) – replace underscores with spaces in all names read, i.e. “sp_name” becomes “sp name”.
Notes
Underscore unmunging is turned off by default, although it is part of the Newick format. Only the cogent3 json and xml tree formats are supported.
- Return type: