Add to documentation

[eberrigan]

• Made inputs for MultipleDicotPipeline explanation in jupyter notebook more clear
• Added HackMD to README for full trait list per pipeline

Summary by CodeRabbit

• Documentation
  • Added a link to detailed trait documentation for pipelines in the project documentation.
• New Features
  • Expanded the MultipleDicotPipeline to include genotype summary statistics retrieval, now requiring genotype information in the input CSV.

[coderabbitai]

Walkthrough

The recent update brings a significant enhancement to the project's functionality. The README.md now includes a link to detailed trait documentation, enriching user guidance. Moreover, the MultipleDicotPipeline in the notebook has been improved to extract genotype summary statistics from an input CSV file, requiring genotype data in the CSV for analysis.

Changes

Files	Change Summary
README.md	Added a link to detailed trait documentation for pipelines.
notebooks/...DicotPipeline.ipynb	Expanded to include genotype summary statistics retrieval from an input CSV file.

🐇✨

In the code's garden, under the moon's soft swirl,
A rabbit appeared with a change, a precious pearl.
"See here," it whispered, "a link to unfurl,
With stats and insights, our data unfurls.
So let's explore these updates and give them a twirl!
🌿📈

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between f481287 and 0372573.

Files selected for processing (2)

• README.md (1 hunks)
• notebooks/MultipleDicotPipeline.ipynb (1 hunks)

Additional comments not posted (1)

README.md (1)

24-26: Ensure the HackMD link is correctly formatted and accessible.

Detailed trait documentation per pipeline is available here:
- [sleap-roots HackMD](https://hackmd.io/DMiXO2kXQhKH8AIIcIy--g)
+ [sleap-roots HackMD](https://hackmd.io/DMiXO2kXQhKH8AIIcIy--g)

[coderabbitai]

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 0372573 and 399e3db.

Files selected for processing (1)

• README.md (1 hunks)

Additional comments not posted (1)

README.md (1)

24-26: Please ensure the link to the HackMD document is accessible to all intended users. If the document has restricted access, consider adding guidance on how users can request access.