Skip to content

Commit

Permalink
chore(#464): update app README
Browse files Browse the repository at this point in the history
  • Loading branch information
tamara-slosarek authored and tamslo committed Aug 4, 2023
1 parent 589528f commit 1a70b04
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 17 deletions.
35 changes: 18 additions & 17 deletions app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,24 @@

The app displays user-specific [PGx](../docs/GLOSSARY.md) information.

Once the user imports their genomic data into the app general
[PGx](../docs/GLOSSARY.md) guidelines can be filtered to fit the genomic
variation of the user.

The user can then search for drugs and receives information about whether the
drug can be used with a standard dose or if the treatment should be changed. Any
treatment changes should be approved by a physician as well. To inform the
physician of the [pharmacogenomic](../docs/GLOSSARY.md) situation the
application offers to export a detailed description. Further, the application
offers a report about potentially dangerous or unsuitable
[drugs](../docs/GLOSSARY.md). To ensure a general comprehension of
[PGx](../docs/GLOSSARY.md) and data security the app provides additional
information on a FAQ page. You can see the mentioned pages in the table below.

Search page | Reports page | FAQ page
:-: | :-: | :-:
![search_screen](https://user-images.githubusercontent.com/61618825/181021369-4cb3a85d-7900-4b57-a147-a7671f5070d6.png) | ![reports_screen](https://user-images.githubusercontent.com/61618825/181021516-b8c1ff7d-c348-40bf-a6d7-9180e3f65249.png) | ![faq_screen](https://user-images.githubusercontent.com/61618825/181021592-ad038ed3-c054-4420-aa83-c0d2e3613229.png)
Once the user imports their genomic data into the app,
[PGx](../docs/GLOSSARY.md) guidelines matching the user's genetic profile are
displayed.

Users can review their gene results [(a), (b)], search for drugs (c), and receive
information about whether a drug can be used at standard dose or if the
treatment may need to be changed (d).

Anytreatment changes should be approved by a pharmacist or physician as well.
To inform the physician of the [PGx](../docs/GLOSSARY.md) results, the
application offers to export a detailed description.

PGx report | Gene details | Drug search | Drug details |
:-: | :-: | :-: | :-: |
(a) | (b) | (c) | (d) |
![report_screen](../docs/screenshots/report.png) | ![gene_screen](../docs/screenshots/gene.png) | ![search_screen](../docs/screenshots/search.png) | ![drug_screen](../docs/screenshots/drug.png) |

_Please note that these screenshots might not represent the latest app version._

## Getting Started

Expand Down
Binary file added docs/screenshots/drug.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/gene.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1a70b04

Please sign in to comment.