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

Offset and limit getDatasetDifferentialExpressionAnalyses endpoint #841

Open
oganm opened this issue Sep 15, 2023 · 2 comments · May be fixed by #859
Open

Offset and limit getDatasetDifferentialExpressionAnalyses endpoint #841

oganm opened this issue Sep 15, 2023 · 2 comments · May be fixed by #859
Labels
cleanup Code reorganization and changes that should not impact functionality rest-api Issues or pull requests involving the RESTful API
Milestone

Comments

@oganm
Copy link
Member

oganm commented Sep 15, 2023

I am a bit unclear on what offset and limit arguments are doing in this enpoint. It seems like unlike all other enpdoints with an offset and limit, they don't provide a totalElements component and this probably makes sense because they always return data from a single experiment as a single object which also makes these arguments entirely pointless as far as I can see.

The example here shows the lack of difference that comes from specifying a limit to one experiment with multiple resultSets and contrasts that may have been subject to the limit albeit likely not very usefully

https://gemma.msl.ubc.ca/rest/v2/datasets/12709/analyses/differential
https://gemma.msl.ubc.ca/rest/v2/datasets/12709/analyses/differential?limit=1

@arteymix
Copy link
Member

That's right, it's completely superfluous.

arteymix added a commit that referenced this issue Sep 15, 2023
… analysis VOs

Remove unnecessary offset/limit parameters of getDatasetDifferentialExpressionAnalyses() (fix #841).

Add a parameter to include analyses of subsets.

Tidy up the DAO:

 - don't retrieve FVs for subsets if includeAnalysesOfSubsets is false
 - initialize proxies of both experiments and subsets

Include analyses of subsets in the output of the endpoint.

Add two new service methods to retrieve analysis VOs: one by a
collection of BioAssaySet and another one for a single BioAssaySet. Use
the latter for the REST API.

Rename sourceExperiment to sourceExperimentId and retain the older name
marked as deprecated (fix #844).
@arteymix arteymix added this to the 1.30.2 milestone Sep 15, 2023
arteymix added a commit that referenced this issue Sep 15, 2023
… analysis VOs

Remove unnecessary offset/limit parameters of getDatasetDifferentialExpressionAnalyses() (fix #841).

Add a parameter to include analyses of subsets.

Tidy up the DAO:

 - don't retrieve FVs for subsets if includeAnalysesOfSubsets is false
 - initialize proxies of both experiments and subsets

Include analyses of subsets in the output of the endpoint.

Add two new service methods to retrieve analysis VOs: one by a
collection of BioAssaySet and another one for a single BioAssaySet. Use
the latter for the REST API.

Rename sourceExperiment to sourceExperimentId and retain the older name
marked as deprecated (fix #844).
arteymix added a commit that referenced this issue Sep 20, 2023
… analysis VOs

Remove unnecessary offset/limit parameters of getDatasetDifferentialExpressionAnalyses() (fix #841).

Add a parameter to include analyses of subsets.

Tidy up the DAO:

 - don't retrieve FVs for subsets if includeAnalysesOfSubsets is false
 - initialize proxies of both experiments and subsets

Include analyses of subsets in the output of the endpoint.

Add two new service methods to retrieve analysis VOs: one by a
collection of BioAssaySet and another one for a single BioAssaySet. Use
the latter for the REST API.

Rename sourceExperiment to sourceExperimentId and retain the older name
marked as deprecated (fix #844).
@arteymix arteymix modified the milestones: 1.30.2, 1.31.0 Sep 20, 2023
@arteymix
Copy link
Member

Implementation is in #859.

I'm getting rid of offset/limit altogether and adding a parameter for including analyses of subsets in the output.

@arteymix arteymix added rest-api Issues or pull requests involving the RESTful API cleanup Code reorganization and changes that should not impact functionality labels Sep 21, 2023
@arteymix arteymix modified the milestones: 1.31.0, 1.32.0 Dec 5, 2023
oganm added a commit to PavlidisLab/gemma.R that referenced this issue Feb 28, 2024
@arteymix arteymix modified the milestones: 1.32.0, 1.31.9 Jun 26, 2024
@arteymix arteymix modified the milestones: 1.31.9, 1.31.10 Jul 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup Code reorganization and changes that should not impact functionality rest-api Issues or pull requests involving the RESTful API
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants