DOC: update intro and add link to preprint

GavinHuttley commented 1 week ago

Summary by Sourcery

Update the README to enhance the introduction of diverse_seq and include a link to a relevant preprint.

Documentation:

Updated the README to provide a more detailed introduction to the diverse_seq tool, highlighting its alignment-free algorithms and their application in phylogenetic workflows.
Added a link to a preprint for further reading on the methods implemented in diverse_seq.

sourcery-ai[bot] commented 1 week ago

Reviewer's Guide by Sourcery

This PR updates the README.md file to provide a more comprehensive and accurate description of the diverse_seq project, including its capabilities and performance characteristics. The changes replace the original brief introduction with a more detailed explanation and add a link to the project's preprint.

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

File-Level Changes

Change	Details	Files
Updated project description to better reflect its capabilities and scope	Modified project tagline to emphasize alignment-free algorithms and phylogenetic workflows Added detailed performance metrics for genome analysis Included information about seed phylogeny generation Added reference to the project's preprint	`README.md`

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 1 week ago

Pull Request Test Coverage Report for Build 11785928718

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

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.892%

Totals
Change from base Build 11770334092:	0.0%
Covered Lines:	1190
Relevant Lines:	1295

HuttleyLab / DiverseSeq