Frequently Asked Questions

How do I get help?

The first place to look for help or answers is in here in the documentation. You can use the search bar in the navigation to search for terms or function names. The next place is in the source documentation strings. Some of the source code is available here in the docs, but the rest can be accessed in an interactive environment (e.g., jupyter) by executing a function name followed by one or two question marks. The docstrings often contain detailed descriptions of parameters and example usage. Finally, you can seek further help or advice by raising an Issue on GitHub. To do this, navigate to https://github.com/eaton-lab/toytree/issues and click the green New Issue button in the upper right. Then click on Labels on the right to select "help wanted" or "question" as the category for your issue.

How do I report bug?

If you believe you have encountered a bug in toytree please let us know by raising an Issue on GitHub. To do this, navigate to https://github.com/eaton-lab/toytree/issues and click the green New Issue button in the upper right. Then click on Labels on the right to select "bug".

How can I request a new feature

We are happy to implement new useful methods in toytree that will help to grow its userbase. To request the implementation of a new method please do so by raising an Issue on GitHub. To do this, navigate to https://github.com/eaton-lab/toytree/issues and click the green New Issue button in the upper right. Then click on Labels on the right to select "enhancement".

How can I contribute to toytree

We welcome contributors! If you are interested in contributing to toytree please first read our contributor's guide. This describes a shared framework and style to ensure a cohesive coding style throughout the source code. Then, you can raise an Issue on GitHub to indicate the project you are working on. This way, you can find if others are already working on the method, or find additional contributors for help. To do this, navigate to https://github.com/eaton-lab/toytree/issues and click the green New Issue button in the upper right. Then click on Labels on the right to select "enhancement", and under Assignees, assign your self.