Skip to main content

Simple Newick tree validator and formatter

Project description

Newick Tree Validator and Formatter

Simple utility to validate and format Newick trees.

The main use of this utility is to validate constraint trees used with IQtree2.

IQtree2 can throw hard to understand errors when using constraint trees even if the tree is technically a valid Newick tree.

This utility will catch many of those errors and provide a more detailed error message.

Usage

Validation without formatting:

./main.py <tree.nwk>

In place formatting:

./main.py <tree.nwk> --inplace

Outputting formatted tree to a separate file:

./main.py <tree.nwk> --outfile <output.nwk>

Outputting list of terminal nodes into a text file:

./main.py <tree.nwk> --terminals <terminals.txt>

Requirements

  • Python
  • Typer
  • BioPython

Release

This project uses Poetry for dependency management and packaging.

To build a release, run:

poetry build

To publish a release to PyPI, run:

poetry publish

To publish the release to Github, run:

gh release create 0.4.0 dist/*

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nwkfmt-0.4.0.tar.gz (3.3 kB view hashes)

Uploaded Source

Built Distribution

nwkfmt-0.4.0-py3-none-any.whl (4.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page