Herman Krogstad Nerskar (firstname.lastname@example.org)
Martin Arentsen Espeland (email@example.com)
Nicolay David Mohebi (firstname.lastname@example.org)
Product descriptions requirements
Create an app that provides visualization of a clinical cascade, with the HIV 90-90-90 as the primary example.
- Present visualizations as bar charts from left to right, where each bar is presented as a subset to previous.Needs to be able to be presented in at least three possible ways:
- As percentages, where the first bar in the cascade is 100%, and the subsequent bars as expressed as percentages of the previous
- As raw numbers, but showing both the actual number and the gap.
- As raw data and percentages (on different axis), i.e. bars with the raw data and a line with the percentage.
Specific functionality that is requested:
Because this app should be usable in different settings/ countries and thus different DHIS2 databases, there must be an interface for configuring the cascade and a possibility of saving these configurations for reuse later:
- What data elements/indicators to include in the cascade, as this might differ from country to country or even at different levels within a country.
- The target for each data element/indicator. While the global target for HIV is 90-90-90, it should be possible to set the target in the app.
- Possible to save different configurations
- Switch between saved configurations
- In addition to data element, there must be possible to define time periods and organization unit to display.
- There must be support for downloading the visualizations.
Mock-up of the web application:
Our first mock up on how we pictured the application layout to be. It is inspired by the "Data Visualizer" app from DHISP2.
We have built our application as a single page application, using the angular2 framework. All of the component for handling configuration, data, bar charts and selections are pushed to the same html page, and are displayed accordingly to the basic layout that we have created for the application. From here the services handles all data communication with both users and with DHISP2 through the restful API's Analytics and Data Store.
For more information on the general architecture of angular2 look here:
Technologies and Framework
The biggest choice in this application was to chose the framework Angular 2. It's a popular framework that is well known, and has thoroughly documented features, and is a very good framework for creating web applications. The group members all wanted to get more experience using this framework and we decided conjointly to use Angular 2.
- Angular 2 / 4
- Material Icons
- HTML 5
- CSS 3
- Data Store
Collaboration tool for projects.
Link to our board: https://trello.com/b/xj55ZWho/plans
Collaboration tool for projects
Development platform for host and review code, manage our project and version control
All of our framworks and libraries comes with permisive licenses, and are described further in detail:
Angular 2 / 4
Licence: Apache Licence 2.0
Implications of the licence types:
The two licence types that are included in the framework and libraries we use are MIT and Apache Licence 2.0.
A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.
Apache Licence 2.0:
"A permissive license whose main conditions require preservation of copyright and license notices. Contributors provide an express grant of patent rights. Licensed works, modifications, and larger works may be distributed under different terms and without source code."
There is no implications by using the libraries that we have used. The only implication is that we cannot re-sell or any of the icons used through material icons since they are under a Apache 2.0 licence.
Division of labour
Martin: Design & Documentation
Herman: Data handling & Analysis
Timeline for project
- Getting Github and choosing all tools.
- Start of developement
Week 43: Continue to finalize first prototype and working version
- Having a working first version in regards to all necessary functionality
- Redesign and testing
Week 45: Redesign and testing
Week 46: Testing and documentation
Week 47: Testing,finalizing of project and documentation