Enhance Compartment Labels
Compartment Labels are currently very limited in length th avoid wrapping. (A second line was introduced by #271 to separate the test and vaccination glyphs from the compartment name/infection state)
We should enhance the Compartment label display to make it more robust for the upcoming compartment filters (#58 ).
The label could be split into two parts: the name (blue) and the glyphs (yellow)
On long names the overflow would be omitted by and ellipsis (...) to avoid wrapping.
A tooltip would be added to display the full name on hover.
The tooltip could also be filled with a description (for compartment filters) that can be set by the user.
Additional explanation or info e.g. regarding the infection state, source of the number, or criteria what makes a subject part of this compartment could also be displayed.
Additionally, if we can find meaningful glyphs or abbreviations for the infection states, the glyph section of the compartment could become an 'at-a-glance' summary of what the compartment consists of (for basic compartment filters and default compartments).
Technical Notes:
The HTML tooltip is done by wrapping the ListItemText-Element that displays the compartment name with a Tooltip-Element and settint the title-prop to a React.Fragment:
<Tooltip
title={
<React.Fragment>
<Typography color="inherit">Non-Symptomatic</Typography>
๐งช - Tested/Confirmed Cases<br/>
๐๐ - Vaccinated Twice<br/>
<br/>
<em><b>Non-Symptomatic</b></em> Cases are Infected People who do not show any symptoms.<br/>
However, they are <b>still infectious</b> and able to spread the disease to healthy people.
</React.Fragment>
}
>
<ListItemText
...
/>
</Tooltip>
I think a detail description of the labels is relevant for every infection state.
The compartments have changed (simplified) since the issue was created. Descriptions can be added to the Compartments, text needs to be supplied by @KleinAn.
@annawendler can we create the information/ description together?
The compartments we use in the model are described here https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1010054 on page 3. For the visualization we aggregated the compartments as follows:
| ESID compartments | Model compartments |
|---|---|
| MildInfections | ExposedNaive |
| ExposedPartialImmunity | |
| ExposedImprovedImmunity | |
| InfectedNoSymptomsNaive | |
| InfectedNoSymptomsPartialImmunity | |
| InfectedNoSymptomsImprovedImmunity | |
| InfectedNoSymptomsNaiveConfirmed | |
| InfectedNoSymptomsPartialImmunityConfirmed | |
| InfectedNoSymptomsImprovedImmunityConfirmed | |
| InfectedSymptomsNaive | |
| InfectedSymptomsPartialImmunity | |
| InfectedSymptomsImprovedImmunity | |
| InfectedSymptomsNaiveConfirmed | |
| InfectedSymptomsPartialImmunityConfirmed | |
| InfectedSymptomsImprovedImmunityConfirmed | |
| Hospitalized | InfectedSevereNaive |
| InfectedSeverePartialImmunity | |
| InfectedSevereImprovedImmunity | |
| ICU | InfectedCriticalNaive |
| InfectedCriticalPartialImmunity | |
| InfectedCriticalImprovedImmunity | |
| Dead | InfectedCriticalImprovedImmunity |
| DeadPartialImmunity | |
| DeadImprovedImmunity |
@NXXR @JonasGilg We also created some texts here:
Milde Infektion: Personen, die an einer SARS-CoV-2-Infektion infiziert sind und keine oder milde Symptome zeigen.
Hospitalisiert: Personen, die aufgrund einer SARS-CoV-2-Infektion im Krankenhaus sind.
Intensivpatient: Personen, die aufgrund einer SARS-CoV-2-Infektion auf der intensivmedizinischen Station sind.
Verstorben: Personen, die durch SARS-CoV-2-Infektione verstorben sind.
Mild infection: People who are infected with SARS-CoV-2 and show no or mild symptoms.
Hospitalized: Individuals who are hospitalized due to SARS-CoV-2 infection.
Intensive care patient: Persons who are in the intensive care unit due to a SARS-CoV-2 infection.
Deceased: Persons who have died due to SARS-CoV-2 infection.
@fifth-island this could also go into the knowledge base (maybe something to test the link feature with) ๐ค
added in #414