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

[REF] Make session count names clearer in query response #282

Merged
merged 4 commits into from
Feb 28, 2024

Conversation

alyssadai
Copy link
Contributor

@alyssadai alyssadai commented Feb 28, 2024

Changes proposed in this pull request:

  • Response model for a single matching session response updated
  • Query template updated
  • Default SPARQL query regenerated

Note:

  • the query parameters themselves have not been renamed (b/c min_num_{phenotypic,imaging}_sessions still makes more sense in a query)
  • we currently (still) do not have a field in a single session query response that indicates the total (not matching) num. of sessions available for the subject. however, this can be deduced from the number of session objects present for a subject in the full response

Checklist

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see https://neurobagel.org/contributing/pull_requests for more info)
  • PR has a label for the release changelog or skip-release (to be applied by maintainers only)
  • PR links to GitHub issue with mention Closes #XXXX
  • Tests pass
  • Checks pass

For new features:

  • Tests have been added

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

@alyssadai alyssadai added the pr-minor-breaking Feature or enhancement that breaks compatibility, will increment minor version (0.+1.0) label Feb 28, 2024
@coveralls
Copy link
Collaborator

coveralls commented Feb 28, 2024

Pull Request Test Coverage Report for Build 8083459842

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 2 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 99.785%

Totals Coverage Status
Change from base Build 7999458202: 0.0%
Covered Lines: 929
Relevant Lines: 931

💛 - Coveralls

Copy link
Contributor

@surchs surchs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, thanks @alyssadai!

I have not tested this query myself, and that makes me think it'd be nice to have at least one test that would do that for us automatically.

🧑‍🍳

README.md Outdated Show resolved Hide resolved
Co-authored-by: Sebastian Urchs <surchs@users.noreply.github.com>
@alyssadai alyssadai merged commit 2b1377b into main Feb 28, 2024
4 of 5 checks passed
@alyssadai alyssadai deleted the fix-session-count-names branch February 28, 2024 16:07
@surchs
Copy link
Contributor

surchs commented Apr 11, 2024

🚀 PR was released in v0.2.0 🚀

@surchs surchs added the released This issue/pull request has been released. label Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-minor-breaking Feature or enhancement that breaks compatibility, will increment minor version (0.+1.0) released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update num_{imaging,phenotypic}_sessions to be num_matching_{imaging,phenotypic}_sessions
3 participants