Objective
Client's Goal: as per GR-136 (Jira server):
GOBii-GDM has been designed to allow breeding programs define their own meta information they would like to store without having to make modifications to database schema. These meta information are referred to as property fields or simply properties.
GDM currently allows users to only extract system defined properties, which are commonly known meta information that are pre-defined in any instance of GDM. This means that users cannot extract custom defined properties that they have loaded data to.
Users will like to be able to extract meta information they have loaded to GDM, both system defined and custom ones.
In addition, there is a need for IDs to be extracted for various entities.
User Story:
As a GDM user, I want to be able to extract additional fields including various props and IDs.
- For sample.file
- Props (both system and user defined)
- germplasm props
- dnasample props
- project props
- IDs:
- germplasm_id
- dnasample_id
- dnarun_id
- Props (both system and user defined)
- For marker.file:
- marker props (both system and user defined)
- IDs:
- marker_id
- linkage_group_id
- Headers for props fields in the files should be prefixed with the main entity table name. e.g. trial_name in dnasample props should have a header "dnasample_trial_name" in sample.file
- Dataset.hmp.txt will contain all the props fields, both system and user defined
Acceptance Criteria:
Extract output sample.file contains the props, both system and user defined, and the various IDs (as listed above)
Extract output marker.file contains the props, both system and user defined, and the various IDs (as listed above)
Extract output Dataset.hmp.txt contains all the props fields, both system and user defined
Success metrics
| Goal | Metric |
|---|---|
Assumptions
Requirements
| # | Requirement | User Story | Importance | Jira Issue | Notes |
|---|---|---|---|---|---|
| 1 | Extract to sample.file - props and IDs GDM-441 - Getting issue details... STATUS | As a GDM user, I want to be able to extract additional fields including various props and IDs. For sample.file
| HIGH | ||
| 2 | Extract to marker.file - props and IDs GDM-442 - Getting issue details... STATUS | As a GDM user, I want to be able to extract additional fields including various props and IDs.
| |||
| 3 | Extract props to Dataset.hmp.txt GDM-443 - Getting issue details... STATUS | As a GDM user, I want to be able to extract additional props fields and see them in Dataset.hmp.txt
|
User interaction and design
Open Questions
| Question | Answer | Date Answered |
|---|---|---|
Should the following properties be extracted:
| yes to project props, no to mapset and platform props | |
| What samples fields should be included in Hapmap file? | all props fields should be included |