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

[ENH] Document descriptive and machine-optimized query result TSVs #245

Merged
merged 4 commits into from
Nov 25, 2024

Conversation

alyssadai
Copy link
Contributor

@alyssadai alyssadai commented Nov 23, 2024

Changes proposed in this pull request:

  • Update "Downloading query tool results" section to reflect new query result TSVs
    • Move example result TSVs into expandable admonitions
  • Switch to tables for column descriptions (for reviewer: thoughts on storing these in TSVs in this repo?)
  • Update section on aggregate query results to clarify possibility of both aggregate and subject-level data in a query result TSV

TODO: Confirm that query result TSVs look correct in preview after neurobagel/neurobagel_examples#45 is merged

Checklist

Please leave checkboxes empty for PR reviewers

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF]) see our Contributing Guidelines for more info)
  • PR links to GitHub issue with mention Closes #XXXX
  • Checks pass

- update example TSV refs
- switch to tables for column descriptions
@alyssadai alyssadai requested a review from rmanaem November 23, 2024 23:38
Copy link

netlify bot commented Nov 23, 2024

Deploy Preview for neurobagel-documentation ready!

Name Link
🔨 Latest commit 7c27da6
🔍 Latest deploy log https://app.netlify.com/sites/neurobagel-documentation/deploys/6744cfb0cb8a5b0008067781
😎 Deploy Preview https://deploy-preview-245--neurobagel-documentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

- URL is working but consistently fails in check due to some intermittent connection problem
- see tcort/markdown-link-check#290 for similar issue
@alyssadai
Copy link
Contributor Author

@neurobagel/dev, I'm going to go ahead and merge this for now to unblock our BIC node redeployment, and for the sake of keeping the docs up-to-date with our deployed tools (this PR is related to neurobagel/query-tool#370).

That said, I'd still appreciate some feedback on the new text / tables when you have a chance!

@alyssadai alyssadai added flag:discuss Flag issue that needs to be discussed before it can be implemented. and removed flag:discuss Flag issue that needs to be discussed before it can be implemented. labels Nov 25, 2024
@alyssadai alyssadai merged commit 75c7859 into main Nov 25, 2024
6 checks passed
@alyssadai alyssadai deleted the update-query-results-docs branch November 25, 2024 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update the relevant sections to reflect the changes made to query tool result files
1 participant