Spec

[advweb-grp1]

Initial issue to document the specifications. This issue will evolve as new discoveries are made through out the project.

[advweb-grp1]

Initial read through. WANT: Web application WHY: To foster better collaboration and aid the speed of cardiovascular research. WHO: Research group.

[advweb-grp1]

Tech Requirements:

• Web application
  • Backend (NodeJS/Firebase) + Frontend (VueJS)
• Display graphs
• Dataset?
  • Understand the entities required.
  • Home page.
  • Are we provided with assets? icon, logos and colour scheme?
  • User authentication / authorisation.

    Functional Requirements:

• Query existing data?
  • What type of queries? e.g. Is the requirement just to return existing data? What type of analysis will be carried out? Can we improve on any manual analysis?
  • Sorting? Pagination? Search?
  • Are there dates involved? We could set a datetime offset?
  • What does it mean by "Other related database?" Is there a API to query this data? Are we required to find our own? If so, what requirements should be reviewed first?
  • What type of graphs will be useful? bar? Histogram? line? ect.
  • Define "Appropriate experimental data?" Is that the provided dataset? or something different?
  • What types of data needs to be submitted? one set of data? or is there multiple?
  • UX - Is there a requirement for what should be on the home page? or should this just be the user login page?
  • When registering, what user information should be required?
  • Are there any user creation validation? e.g. age and academic institution that they are linked to and password validation?
  • Do we need to verify emails?
  • Are there user roles? Such as admin and normal users?
  • Two factor authentication required?
  • Do we need to make the experimental data visually clear from the data gathered from third party APIs?

Additional Features

• Should the data be downloadable as CSV or other formats?
• Should the graphs be exportable as a png or JEPG?
• Does the graph need to have its own set of functionality?
  • Add new plots?
  • Remove plots?
  • Edit plots?
  • Zoom in and out?
  • Change title?
  • Colour?
  • Exclude data?
• Should the graph include a line of best fit?

[advweb-grp1]

Answers

General

• Users will post data in regards to a participant with heart conditions.
• Context provided surrounding the system. The system should present data to researchers / scholars for the heart condition cardiomyopathy. TLDR: Heart issues whereby a mutation leads to less blood being circulated around the body.
• Assets are decided by developers
• The information to present should be decided by developers so long as it is considered "useful"
• Graphs and charts are decided by the developer.
• UX is decided by the use case tables.
• Probably no user roles involved.
• Shouldn't think about two factor auth right now.
• We can include a small footnote for any third party data presented.
• Additional features are decided by the developer.

Dataset

• CSV file hcm_data.csv
• Each record represents a single patient / research subject / volunteer ect
• The data set contains mutations and blood volume.
• No dates are in that data set
• "Other related data" is a optional API that we can query for accurate heart condition definitions or results. We have been presented with a list of options.
  1. hpo: Human Phenotype Ontology
  2. OMIM: Online Mendelian Inheritance in Man.
  3. MGI. https://www.informatics.jax.org/
  4. NCBI SNP Database. https://www.ncbi.nlm.nih.gov/snp/

[advweb-grp1]

Third party API research:

1. hpo: Human Phenotype Ontology
2. OMIM: Online Mendelian Inheritance in Man.
3. MGI. https://www.informatics.jax.org/
4. NCBI SNP Database. https://www.ncbi.nlm.nih.gov/snp/

[AymanReh]

Do we need to create a page for users to edit user data?

No, according to the spec we do not need to change any user data other than allowing them to change their password, which has already been done in #32 . Nor do we need any edit user functions.

Do we need a single page view for participant data sets?

No, in the spec it doesn't say anywhere we need to create a single page view for data sets. We just need to allow users to query data, allow them to search for a specific terms e.g. ledv. And to present the data including a data plot