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

Standardize query result files #389

Closed
alyssadai opened this issue Dec 3, 2024 · 2 comments · Fixed by #398
Closed

Standardize query result files #389

alyssadai opened this issue Dec 3, 2024 · 2 comments · Fixed by #398
Assignees
Labels
released This issue/pull request has been released.

Comments

@alyssadai
Copy link
Contributor

We will have two files with the same columns and order of columns, according to https://docs.google.com/spreadsheets/d/1rLgbzZv1AqgYTGglI3yuQVdOM1bbYvvY8ijmbTXsfHg/edit?usp=sharing

  • note that at least one column name has been updated as well
  1. File with descriptive labels (human-readable)
  2. File with URIs (machine-optimized)
@alyssadai alyssadai moved this to Backlog in Neurobagel Dec 3, 2024
@surchs surchs moved this from Backlog to Specify - Active in Neurobagel Dec 4, 2024
@rmanaem rmanaem moved this from Specify - Active to Specify - Done in Neurobagel Dec 4, 2024
@rmanaem rmanaem self-assigned this Dec 4, 2024
@rmanaem rmanaem moved this from Specify - Done to Implement - Active in Neurobagel Dec 4, 2024
@alyssadai
Copy link
Contributor Author

alyssadai commented Dec 6, 2024

Hey @neurobagel/dev, a quick additional thought on this I realized we didn't discuss in #376 .

How do we feel about renaming the results files to something clearer, now that we no longer have dataset and participant files:

One suggestion:

  • cohort-participant-machine-results.tsv -> neurobagel-query-results-with-URIs.tsv
  • cohort-participant-results.tsv -> neurobagel-query-results.tsv

Goal would be that a user should be able to:

  • Easily identify which files are Neurobagel query tool results files within their own FS
  • Know, semi-intuitively, based off the title what the files contain (ideally, they would convey that they are the same info, just in two different representations)

@alyssadai alyssadai moved this from Implement - Active to Implement - Done in Neurobagel Dec 6, 2024
@rmanaem rmanaem linked a pull request Dec 6, 2024 that will close this issue
8 tasks
@surchs surchs moved this from Implement - Done to Review - Active in Neurobagel Dec 11, 2024
@rmanaem rmanaem removed a link to a pull request Dec 12, 2024
8 tasks
@github-project-automation github-project-automation bot moved this from Review - Active to Review - Done in Neurobagel Dec 13, 2024
Copy link
Contributor

🚀 Issue was released in v0.8.0 🚀

@neurobagel-bot neurobagel-bot bot added the released This issue/pull request has been released. label Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released This issue/pull request has been released.
Projects
Status: Review - Done
Development

Successfully merging a pull request may close this issue.

2 participants