Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Datasets README.md to clarify dataset contribution workflow #26

Merged
merged 2 commits into from
Oct 23, 2024
Merged

Update Datasets README.md to clarify dataset contribution workflow #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ba2b18
Update README.md
Oufattole Oct 22, 2024
6335cc1
fixed pre-commit issue with the datasets readme
Oufattole Oct 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions src/MEDS_DEV/datasets/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,17 @@

This folder contains details for datasets currently included in the MEDS-DEV effort.

TODO: More details.
To contribute a new dataset:

1. Fork this repository
2. Add your dataset predicates file in its respective folder (see `MIMIC-IV/predicates.yaml` for an example of predicate structure)
3. Test locally to ensure your dataset works correctly
4. Create a pull request with your changes

## Notes

If you have a version of a task configuration file that is more specialized to a dataset than can be achieved
with overwriting the predicates alone, then (1) make a GitHub issue explaining why the existing file is not
used, and (2) add a file here `../tasks/$DATASET_NAME/$TASK_NAME.yaml` with that configuration.
with overwriting the predicates alone, then:

1. Make a GitHub issue explaining why the existing file is not used
2. Add a file here `../tasks/$DATASET_NAME/$TASK_NAME.yaml` with that configuration.
Loading