Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 2.16 KB

AnalysisCommon.md

File metadata and controls

38 lines (29 loc) · 2.16 KB

AnalysisCommon

attributes common between request and return objects

Properties

Name Type Description Notes
study str [optional]
table_id str [optional]
entities List[Entity] [optional]
order int [optional]
metadata object [optional]
role str What the coordinates are for (study_schema CoordinateRole): `result`, `anchor`, `localization`, `reference` or `other`; an open vocabulary, so the source's own wording may appear. Only a result is released in a studyset. Null on an analysis from before roles, which is read as a result, except on a set the study_schema ingester wrote, which is unclassified. [optional]
relabelled_by str The parse_id of the reviewed revision whose relabel verdict set `role`; a later parse does not replace a relabelled role. Null while the role is the classifier's, whose name and version are in `metadata.role_source` (study_schema's `role_source`). [optional]
outcome str Whether anything survived the analysis's threshold (study_schema AnalysisOutcome), from the extraction record. The ingester sets it only on results. [optional]
from_prior_study bool The coordinates are quoted from an earlier study, not this one's. [optional]

Example

from neurostore_sdk.models.analysis_common import AnalysisCommon

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

# convert the object into a dict
analysis_common_dict = analysis_common_instance.to_dict()
# create an instance of AnalysisCommon from a dict
analysis_common_from_dict = AnalysisCommon.from_dict(analysis_common_dict)

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