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

Expand info on matching dataset cards #377

Open
alyssadai opened this issue Nov 26, 2024 · 0 comments
Open

Expand info on matching dataset cards #377

alyssadai opened this issue Nov 26, 2024 · 0 comments
Labels
flag:discuss Flag issue that needs to be discussed before it can be implemented.

Comments

@alyssadai
Copy link
Contributor

alyssadai commented Nov 26, 2024

The results card for a dataset matching a given query should display additional info including:

  • Is the dataset a DataLad dataset?
  • Is the dataset aggregated (i.e., subject-level results protected) or not?

This info must be extracted from details for the matching dataset in the response the query tool receives from the API (for example response, see https://github.com/neurobagel/neurobagel_examples/blob/5690cd4f42ca9df9651e93d488b9acad3cdf3213/api-responses/fapi_query_success_200.json).

  • Is the dataset a DataLad dataset?
    • Potentially a more complicated check
    • Right now, typical features of a DataLad dataset in Neurobagel are:
    • BUT, not all datasets with a GitHub URL are DataLad datasets!
    • Some ideas: see if there's a datalad command that checks if a link resolves to a valid DataLad dataset, or a dry-run version of e.g., datalad install / datalad clone that will error out for non-DataLad datasets
  • Is the dataset aggregated (i.e., subject-level results protected) or not?
    • Can check that the value for the subject_data key is the string protected
ShubhamShekhawat added a commit to ShubhamShekhawat/query-tool that referenced this issue Dec 27, 2024
@rmanaem rmanaem added the flag:detail needed Issue requires additional clarification before a decision can be made or it can be implemented. label Jan 23, 2025
@alyssadai alyssadai added flag:discuss Flag issue that needs to be discussed before it can be implemented. and removed flag:detail needed Issue requires additional clarification before a decision can be made or it can be implemented. labels Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
flag:discuss Flag issue that needs to be discussed before it can be implemented.
Projects
Status: No status
Development

Successfully merging a pull request may close this issue.

2 participants