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.

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

Review and comments data dictionary #108

Open
fkiraly opened this issue Oct 30, 2024 · 1 comment
Open

Review and comments data dictionary #108

fkiraly opened this issue Oct 30, 2024 · 1 comment
Assignees
Labels
modeldev Developing modeling pipelines for meal annotation task.

Comments

@fkiraly
Copy link

fkiraly commented Oct 30, 2024

Short review of the data dictionary as current in
https://github.com/RobotPsychologist/bg_control/blob/main/data/data_dictionary.md

I have two main comments:

  • the dictionary describes only the column names, but not the full contents or context of the dataset, e.g., the object it describes or what rows mean, what the files are
  • there is possibly a separate extraction process which might be worth to report as well, but perhaps best done in a second step after a good description of the individual extracts are available.
    • this might be important in particular for the purpose of model building, e.g., to understand the "full" data set for the purpose of creating a simulator that produces data of the same type

For convenience, I have added a link to a "data dictionary writing guide" I created a while ago, here:

https://github.com/sktime/datadict-howto

Side note: There is the raw data and the processed data. If we would expect most analyses to start at the processed data, it might be worth writing clean data dictionaries for both data batches.

@andytubeee
Copy link
Contributor

.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
modeldev Developing modeling pipelines for meal annotation task.
Projects
None yet
Development

No branches or pull requests

4 participants