Skip to content

Commit

Permalink
docs(app): use medication wording in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tamslo committed Mar 22, 2024
1 parent c993399 commit 8be0662
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 53 deletions.
50 changes: 25 additions & 25 deletions docs/App-screens.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,28 @@ table row.

| # | Action | Screen | Description |
| - | ------ | ------ | ----------- |
| 1 | App opened the first time | <img src="./screenshots/login.png" width="60%"> | Login screen with data provider selection |
| 2 | _Get data_ 👆 | <img src="./screenshots/login-redirect.png" width="60%"> | Alert for login redirect |
| 3 | _Continue_ 👆 | <img src="./screenshots/keycloak-login.png" width="60%"> | Rectedirect to Keycloak login page |
| 4 | _Sign In_ 👆 | <img src="./screenshots/import-success.png" width="60%"> | Back to app, import was successful |
| 5 | _Continue_ 👆 | <img src="./screenshots/onboarding-1.png" width="60%"> | Onboarding (screen 1 of 5) |
| 6 | _Next_ 👆 | <img src="./screenshots/onboarding-2.png" width="60%"> | Onboarding (screen 2 of 5) |
| 7 | _Next_ 👆 | <img src="./screenshots/onboarding-3.png" width="60%"> | Onboarding (screen 3 of 5) |
| 8 | _Next_ 👆 | <img src="./screenshots/onboarding-4.png" width="60%"> | Onboarding (screen 4 of 5) |
| 9 | _Next_ 👆 | <img src="./screenshots/onboarding-5.png" width="60%"> | Onboarding (screen 5 of 5) |
| 10 | _Get started_ 👆 | <img src="./screenshots/drug-selection.png" width="60%"> | Initial active drug selection |
| 11 | _Continue_ 👆 | <img src="./screenshots/gene-report.png" width="60%"> | Gene report, showing all genes that can be mapped to PGx guidelines |
| 12 | _CYP2D6_ tile 👆 | <img src="./screenshots/cyp2d6.png" width="60%"> | Gene details; the notice about influence of other drugs is only shown for genes where drug-gene interactions are implemented |
| 13 | _Amitriptyline_ tile 👆 | <img src="./screenshots/amitriptyline.png" width="60%"> | Drug with unknown guideline detail; shown in green since standard dosing is applied without guidelines (_note for this example: the guideline for this genotype was not published in the backend at time of screenshot creation, which is why the guideline in missing in this case_) |
| 14 | _Drugs_ navigation tab 👆 | <img src="./screenshots/drug-search.png" width="60%"> | Drug search page |
| 15 | _?_ icon 👆 | <img src="./screenshots/drug-search-tooltip.png" width="60%"> | Tooltip explaining search feature; tooltips look the same on all pages |
| 16 | Filter icon 👆 | <img src="./screenshots/drug-search-filter.png" width="60%"> | Available search filters |
| 17 | _Clopidogrel_ tile 👆 | <img src="./screenshots/clopidogrel.png" width="60%"> | Drug with known guideline |
| 18 || <img src="./screenshots/clopidogrel-scrolled.png" width="60%"> | At the bottom of a drug, a link to the underlying guideline is given; this link redirects the user to the guideline website |
| 19 | Share icon (in header) 👆 | <img src="./screenshots/pdf-export.png" width="60%"> | Create a PDF document to share with others |
| 20 | _FAQ_ navigation tab 👆 | <img src="./screenshots/faq.png" width="60%"> | FAQ page |
| 21 | First FAQ list item 👆 | <img src="./screenshots/faq-first-item.png" width="60%"> | Extended FAQ item |
| 22 || <img src="./screenshots/faq-contact.png" width="60%"> | "Contact us" at the end of the FAQ in case of more questions; will open the user's default email app with the development team address pre-filled |
| 23 | _More_ navigation tab 👆 | <img src="./screenshots/more.png" width="60%"> | "More" page with settings and further information; "Onboarding" will start the onboarding again (screens 5 to 10) |
| 24 | #23 _About us_ 👆 | <img src="./screenshots/about-us.png" width="60%"> | "About us" page; "Privacy policy" and "Terms of use" have the same page style (currently only lorem ipsum) |
| 25 | #23 _Delete app data_ 👆 | <img src="./screenshots/delete-app-data.png" width="60%"> | Deletes all app data and redirects to screen 1; continuing is only possible when the checkmark was clicked |
| 1 | App opened the first time | <img src="./screenshots/login.png" width="60%" alt="login"> | Login screen with data provider selection |
| 2 | _Get data_ 👆 | <img src="./screenshots/login-redirect.png" width="60%" alt="login-redirect"> | Alert for login redirect |
| 3 | _Continue_ 👆 | <img src="./screenshots/keycloak-login.png" width="60%" alt="keycloak-login"> | Redirect to Keycloak login page |
| 4 | _Sign In_ 👆 | <img src="./screenshots/import-success.png" width="60%" alt="import-success"> | Back to app, import was successful |
| 5 | _Continue_ 👆 | <img src="./screenshots/onboarding-1.png" width="60%" alt="onboarding-1"> | Onboarding (screen 1 of 5) |
| 6 | _Next_ 👆 | <img src="./screenshots/onboarding-2.png" width="60%" alt="onboarding-2"> | Onboarding (screen 2 of 5) |
| 7 | _Next_ 👆 | <img src="./screenshots/onboarding-3.png" width="60%" alt="onboarding-3"> | Onboarding (screen 3 of 5) |
| 8 | _Next_ 👆 | <img src="./screenshots/onboarding-4.png" width="60%" alt="onboarding-4"> | Onboarding (screen 4 of 5) |
| 9 | _Next_ 👆 | <img src="./screenshots/onboarding-5.png" width="60%" alt="onboarding-5"> | Onboarding (screen 5 of 5) |
| 10 | _Get started_ 👆 | <img src="./screenshots/drug-selection.png" width="60%" alt="drug-selection"> | Initial selection of current medications |
| 11 | _Continue_ 👆 | <img src="./screenshots/gene-report.png" width="60%" alt="gene-report"> | Gene report, showing all genes that can be mapped to PGx guidelines |
| 12 | _CYP2D6_ tile 👆 | <img src="./screenshots/cyp2d6.png" width="60%" alt="cyp2d6"> | Gene details; the notice about influence of other medications is only shown for genes for which phenoconversion implemented |
| 13 | _Amitriptyline_ tile 👆 | <img src="./screenshots/amitriptyline.png" width="60%" alt="amitriptyline"> | Medication with unknown guideline detail; shown in green since standard dosing is applied without guidelines (_note for this example: the guideline for this genotype was not published in the backend at time of screenshot creation, which is why the guideline in missing in this case_) |
| 14 | _Medications_ navigation tab 👆 | <img src="./screenshots/drug-search.png" width="60%" alt="drug-search"> | Medication search page |
| 15 | _?_ icon 👆 | <img src="./screenshots/drug-search-tooltip.png" width="60%" alt="drug-search-tooltip"> | Tooltip explaining search feature; tooltips look the same on all pages |
| 16 | Filter icon 👆 | <img src="./screenshots/drug-search-filter.png" width="60%" alt="drug-search-filter"> | Available search filters |
| 17 | _Clopidogrel_ tile 👆 | <img src="./screenshots/clopidogrel.png" width="60%" alt="clopidogrel"> | Medication with known guideline |
| 18 || <img src="./screenshots/clopidogrel-scrolled.png" width="60%" alt="clopidogrel-scrolled"> | At the bottom of a medication, a link to the underlying guideline is given; this link redirects the user to the guideline website |
| 19 | Share icon (in header) 👆 | <img src="./screenshots/pdf-export.png" width="60%" alt="pdf-export"> | Create a PDF document to share with others |
| 20 | _FAQ_ navigation tab 👆 | <img src="./screenshots/faq.png" width="60%" alt="faq"> | FAQ page |
| 21 | First FAQ list item 👆 | <img src="./screenshots/faq-first-item.png" width="60%" alt="faq-first-item"> | Extended FAQ item |
| 22 || <img src="./screenshots/faq-contact.png" width="60%" alt="faq-contact"> | "Contact us" at the end of the FAQ in case of more questions; will open the user's default email app with the development team address pre-filled |
| 23 | _More_ navigation tab 👆 | <img src="./screenshots/more.png" width="60%" alt="more"> | "More" page with settings and further information; "Onboarding" will start the onboarding again (screens 5 to 10) |
| 24 | #23 _About us_ 👆 | <img src="./screenshots/about-us.png" width="60%" alt="about-us"> | "About us" page; "Privacy policy" and "Terms of use" have the same page style (currently only lorem ipsum) |
| 25 | #23 _Delete app data_ 👆 | <img src="./screenshots/delete-app-data.png" width="60%" alt="delete-app-data"> | Deletes all app data and redirects to screen 1; continuing is only possible when the checkmark was clicked |
10 changes: 3 additions & 7 deletions docs/GLOSSARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,9 @@ understanding of this project's code.
<dd>PGx is an abbreviation of <em>pharmacogenetics</em>, the study of how
pharmacology is affected by <em>individual genes</em>.</dd>

<dt>Drug</dt>
<dd>Linguistically synonymous to the term <em>medication</em>, but preferred
for this project. Ibuprofen is an example of a <em>drug</em>.</dd>

<dt>RxNorm, RxCUI</dt>
<dd><em>RxNorm</em> is a US-specific standardized naming system for drugs.
RxNorm also defines IDs for drugs, known as
<dd><em>RxNorm</em> is a US-specific standardized naming system for
medications. RxNorm also defines IDs for medications, known as
<em>RxCUI</em>s.</dd>
<dd><a href="https://www.merriam-webster.com/dictionary/Rx">Trivia</a>: Rx
stems from the latin word <em>recipe</em> meaning "take". The first doctor to
Expand All @@ -26,7 +22,7 @@ understanding of this project's code.
"Rx concept unique identifier".</dd>

<dt>Indication</dt>
<dd>Defines the reason a drug is used, e.g. fever for ibuprofen.</dd>
<dd>Defines the reason a medication is used, e.g. fever for ibuprofen.</dd>
</dl>

## Biomedical terms
Expand Down
44 changes: 23 additions & 21 deletions docs/User-instructions.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<h1>Getting Started with PharMe</h1>
<p>
Welcome to PharMe, an application to gain insights on your DNA's influence
on drugs! 🧬💊🤗
on medications! 🧬💊🤗
</p>
<p>
In the following, we will give you an overview on how to use the app.
Expand All @@ -66,7 +66,7 @@ <h1>Getting Started with PharMe</h1>
</td>
<td>
To get started with PharMe, you first need to import your pharmacogenetic
(PGx) test data (data about your DNA and drugs you are taking) from your
(PGx) test data (data about your DNA and medications you are taking) from your
data provider.
<br/>
<br/>
Expand All @@ -83,17 +83,17 @@ <h1>Getting Started with PharMe</h1>
</td>
<td>
After successfully importing data, you will get an overview about PharMe's
backgound and capabilities in a short onboarding.
background and capabilities in a short onboarding.
<br/>
<br/>
In the initial medication selection you can tell PharMe which medications
you are currently taking – if your PGx test data includes drugs you are
taking, they will be pre-selected here.
you are currently taking – if your PGx test data includes current
medications, they will be pre-selected here.
<br/>
<br/>
Later in the app, you will be able to filter for drugs you are currently
taking; also, some drugs can influence your results for other drugs. Please
take your time here to make the most of PharMe. ☺️
Later in the app, you will be able to filter for medications you are
currently taking; also, some medications can influence your results for
other medications. Please take your time here to make the most of PharMe. ☺️
</td>
</tr>
<tr>
Expand All @@ -120,9 +120,9 @@ <h1>Getting Started with PharMe</h1>
<br/>
<br/>
Selecting a gene will take you to its detail page, with further information
about your result and drugs that are influenced by this gene. For technical
terms (like "genotype"), you can always find explanations by tapping on the
question mark.
about your result and medications that are influenced by this gene. For
technical terms (like "genotype"), you can always find explanations by
tapping on the question mark.
</td>
</tr>
<tr>
Expand All @@ -133,19 +133,21 @@ <h1>Getting Started with PharMe</h1>
</div>
</td>
<td>
You can also view your PGx results by drug on the <i>Drugs</i> screen.
Here, you can search for drugs by their generic name, brand names, or drug
class. You can also filter the list by medications you are currently taking
and by warning levels (❌ ⚠️ ✅).
You can also view your PGx results by medications on the <i>Medications</i>
screen. Here, you can search for medications by their generic name, brand
names, or class. You can also filter the list by medications you are
currently taking and by guideline result (❌ consider alternatives,
⚠️ use with caution, and ✅ standard precautions).
<br/>
<br/>
Selecting a drug (also on the gene detail page) leads to the drug's detail
page.
Selecting a medication (also on the gene detail page) leads to the
medication's page with further details.
<br/>
<br/>
Here you see some general information about the drug and a short statement
what PGx guidelines say about your DNA and this drug. Fore more information,
the respective guideline is linked at the bottom of each drug page.
Here you see some general information about the medication and a short
statement what PGx guidelines say about your DNA and this medication. For
more information, the respective guideline is linked at the bottom of each
medication page.
</td>
</tr>
<tr>
Expand Down Expand Up @@ -173,7 +175,7 @@ <h1>Getting Started with PharMe</h1>
</table>
<p>
We hope by using PharMe you will learn useful information about your DNA and
drugs! Have fun! 💫
medications! Have fun! 💫
</p>
</div>
</body>
Expand Down
7 changes: 7 additions & 0 deletions pharme.code-workspace
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,21 @@
"anni",
"bupropion",
"cinacalcet",
"clopidogrel",
"CPIC",
"diplotype",
"diplotypes",
"drugclass",
"duloxetine",
"haplotype",
"haplotypes",
"Hasso",
"Keycloak",
"MedlinePlus",
"Metabolizer",
"Pharmacogenetics",
"PharMe",
"phenoconversion",
"Plattner"
]
}
Expand Down

0 comments on commit 8be0662

Please sign in to comment.