Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

Target release2.2
Epic
Document status
DRAFT
Document owner
DesignerDeb Weigand
Tech leadKevinPalis
Developer(s)KevinPalis
QADeb Weigand

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
  • 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

GoalMetric


Assumptions

Requirements

#RequirementUser StoryImportanceJira IssueNotes
1Extract to sample.file - props and IDs

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
  • Headers for props fields in sample.file 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
HIGH


2Extract to marker.file - props and IDs

As a GDM user, I want to be able to extract additional fields including various props and IDs.
For marker.file:

  • marker props (both system and user defined)
  • IDs:
    • marker_id
    • linkage_group_id
  • Headers for props fields in marker.file should be prefixed with the main entity table name. e.g. probe1 in dnasample props should have a header "marker_probe1" in marker.file



3Extract props to Dataset.hmp.txt

As a GDM user, I want to be able to extract additional props fields and see them in Dataset.hmp.txt

  • Dataset.hmp.txt will contain all the props fields, both system and user defined
  • Dataset.hmp.txt will not contain any DB IDs



User interaction and design

Open Questions

QuestionAnswerDate Answered

Should the following properties be extracted:

  • project props
  • mapset props
  • platform props

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  

Out of Scope

  • No labels