Update dataset.md

[Oufattole]

Thoughts on the dataset template?

We should add that the user is expected to commit in the pull request:

1. predicates to the file datasets/${dataset_name}/predicates.yaml
2. the filled out pull request template in the file datasets/${dataset_name}/README.md

Summary by CodeRabbit

• New Features
  • Introduced a new markdown template for datasets, enhancing documentation with structured sections for dataset name, description, supported tasks, resources, access details, and compliance checklist.
  • Added a checklist section to ensure compliance with the MEDS-DEV API.
  • Expanded sections to include aggregate statistics, cohort descriptions, and detailed access requirements.

[coderabbitai[bot]]

Walkthrough

The changes introduce a new markdown template for datasets within the src/MEDS_DEV/templates/dataset.md file. This template is structured to include sections for the dataset name, description, supported tasks, resources, access details, and a compliance checklist. The template aims to standardize the documentation process for datasets in the MEDS-DEV project.

Changes

File Path	Change Summary
src/MEDS_DEV/templates/dataset.md	Added a new markdown template for datasets, including sections for name, description, supported tasks, resources, access, and a compliance checklist.

Possibly related PRs

• #26: The changes in the src/MEDS_DEV/datasets/README.md file clarify the dataset contribution workflow, which is related to the new dataset template introduced in the main PR, as both aim to enhance the documentation and guidance for dataset contributions.
• #27: The updates to the AUMCdb dataset's README include a detailed description of access requirements and supported tasks, which aligns with the new sections added in the main PR's dataset template that emphasize access policies and task descriptions.

🐇 In the meadow, templates bloom,
For datasets, they chase away gloom.
With sections neat and checklists bright,
Documentation shines, a pure delight!
Hoppy changes, let’s all cheer,
For structured data, we hold dear! 🌼

---

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[mmcdermott]

I like this, but chat with @prockenschaub and @rvandewater -- they've added similar dataset templating information in #27, @Oufattole

[rvandewater]

@Oufattole do you prefer to take over our changes as you see fit?

[kamilest]

@prockenschaub @rvandewater I tried to merge the two versions for the dataset template (sorry this turned out to be concurrent!) and included suggestions from @Simonlee711 and coderabbit. Let me know if you have any thoughts!

@Jeanselme maybe we should also think about and request more information on any fairness-related considerations for the dataset (e.g. which groups are possible, request their definitions, etc.)

Also cc: @Oufattole @mmcdermott

[rvandewater]

Looks good @kamilest