Open BrapiCoordinatorSelby opened 2 years ago
File Changes
## Get statistical results by trial [/brapi/v2/trials/{id}/statisticalobservations]
Scope: PHENOTYPING, ANALYSIS.
This call is meant to get statistical results based on raw observations, eg. Meta-R. The proposal is included at trial level for multilocaltion analysis results. CIMMYT's IWIS currently supports this information.
Notes: A similar call at study level may be considered for single-site analysis
### Retrieve statistical results by trial's entrys [GET]
+ Parameters
+ trialDbId (required, integer, `T2233`) ... Identifier of the trial. Usually a number, could be alphanumeric.
+ Response 200 (application/json)
{
"metadata": {
"pagination": {
"pageSize": 100,
"currentPage": 0,
"totalCount": 480,
"totalPages": 5
},
"status": [],
"datafiles": []
},
"result": {
"data": [
{
"germplasmDbId": "1",
"entryNumber": "1",
"studyDbId",
"observations": [
{
"observationDbId": 153453453,
"observationVariableId": 18020,
"value": 10.0101
},
{
"observationDbId": 23453454345,
"observationVariableId": 51496,
"value": 11.2021
}
]
}
]
}
}
@j-alberto commented on Jun 15, 2017 this call should be put into Trial's scope.
@jeback1 commented on Jun 22, 2017 Hi Jorge, A couple of questions about your proposed call:
The 'value' key; how does one know whether it is an average, median, or some other statisitc?
Best regards, Jan Erik
@j-alberto commented on Jun 27, 2017 Hello Jan Erik,
StudyDbId with no value: is was a typing error, it should contain the study identifier to associate the results with. Since the results cannot be attached to a single plot, but to all plots with the same germplasm for a given study. This proposal only considers single-site analysis, so for multi-site analysis it may require also trialDbId.
To tell between average, std deviation, etc. We propose using observationVariableId, defining new variables with the same property(trait), and scale of the ones used for raw data , but using different methods: "statistical average", "statistical std deviation", etc. This way we can ask for either raw or statistical observations by specifying the variables we want. They will still be attached to the same trait and germplasm.
@j-alberto commented on Jun 27, 2017 For a better support of single and multi study analysis results some changes need to be considered.
All of this is a preliminary approach which needs to be discussed, of course.
This was originally in pull request #74 started in June 2017. This pull request is now wildly out of date and needs to be closed. However, the idea and comments are still relevant, perhaps more relevant now that BrAPI has reached a new level of maturity.