Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 2.36 KB

AnalysisQueryRequest.md

File metadata and controls

36 lines (27 loc) · 2.36 KB

AnalysisQueryRequest

Properties

Name Type Description Notes
query AnalysisQuery
page int Which page of studies to list, in order of paper. [optional] [default to 1]
page_size int How many studies a page lists, each with all its selected analyses; 0 lists none. [optional] [default to 20]
paginate bool False lists every selected study, whatever `page` and `page_size` say. [optional] [default to True]
detail str How much each listed study carries: `studies` only its ids, `analyses` also its selected analyses' ids, names and matches, `features` also their features. With `paginate: false`, `studies` lists every selected study's id at once. [optional] [default to 'features']
base_study_ids List[str] Only the analyses of these papers. The counts, results and funnel cover the same restricted set, so an empty query lists every analysis with features that these papers have. [optional]
study_ids List[str] Only the analyses of these studies (the pipeline studies the results name). With `base_study_ids`, an analysis must be in both. [optional]
funnel bool Also return `searched` and `funnel`: what each criterion in turn keeps and drops, and how many analyses it finds silent. It counts once per criterion, so it costs most when criteria keep most analyses. [optional] [default to False]

Example

from neurostore_sdk.models.analysis_query_request import AnalysisQueryRequest

# TODO update the JSON string below
json = "{}"
# create an instance of AnalysisQueryRequest from a JSON string
analysis_query_request_instance = AnalysisQueryRequest.from_json(json)
# print the JSON string representation of the object
print(AnalysisQueryRequest.to_json())

# convert the object into a dict
analysis_query_request_dict = analysis_query_request_instance.to_dict()
# create an instance of AnalysisQueryRequest from a dict
analysis_query_request_from_dict = AnalysisQueryRequest.from_dict(analysis_query_request_dict)

[Back to Model list] [Back to API list] [Back to README]