DOC: include ctree in the README

GavinHuttley commented 2 weeks ago

Summary by Sourcery

Documentation:

Add documentation for the dvs ctree command in the README, including its options and usage.

sourcery-ai[bot] commented 2 weeks ago

Reviewer's Guide by Sourcery

This PR primarily updates the documentation by adding the ctree command documentation to the README and making minor text improvements throughout the documentation. The changes include fixing typos, reordering lists, and clarifying command descriptions.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Added comprehensive documentation for the `ctree` command	Added command line options and usage instructions Added cogent3 app documentation for dvs_ctree and dvs_par_ctree Included detailed parameter descriptions and notes about composability	`README.md`
Fixed documentation inconsistencies and improved clarity	Corrected file extension from .dvtgseqs to .dvseqs Reordered input/output type lists to be consistent Simplified molecular type description Fixed grammatical error in parallel tree app description	`README.md` `src/diverse_seq/cluster.py`

Tips and commands

#### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).

coveralls commented 2 weeks ago

Pull Request Test Coverage Report for Build 11720501620

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 91.816%

Totals
Change from base Build 11715228647:	0.0%
Covered Lines:	1178
Relevant Lines:	1283

HuttleyLab / DiverseSeq