added documentation for preview #1
Conversation
docs/getting-started/preview.md
Outdated
| This document is for the preview of W4H toolkit. W4H Toolkit is an ecosystem that covers most of the common features needed when using wearables in a clinical study or or trial. As studies can have very different requirements, W4H toolkit is designed to be flexible and incrementally adoptable. This toolkit provides the following components: | ||
|
|
||
|
|
||
| **Dashboard** : An intuitive interface that offers data input forms and visual analytics tools. |
There was a problem hiding this comment.
Just say what it is not stuff that ChatGPT suggests!
Look at the ICDE demo video/paper (Samrit knows ask in Slack). You want to write something like this:
- Streamlit dashboard featuring:
- Import data
- ...
- Database supporting GeoMTS
- Notebooks:
- Compliance notebooks in pandas/PySpark
docs/getting-started/preview.md
Outdated
| @@ -0,0 +1,79 @@ | |||
| # W4H-Preview | |||
| ## Introduction | |||
| This document is for the preview of W4H toolkit. W4H Toolkit is an ecosystem that covers most of the common features needed when using wearables in a clinical study or or trial. As studies can have very different requirements, W4H toolkit is designed to be flexible and incrementally adoptable. This toolkit provides the following components: | |||
There was a problem hiding this comment.
This is about the container. Just say what it is and how to get it.
W4H Toolkit Preview
This is a preview of the Wearables for Health (W4H) Toolkit. To run the preview:
- Get Docker...
- Install...
Then explain what it contains with links to the dashboard, notebooks, database etc.
| @@ -0,0 +1,79 @@ | |||
| # W4H-Preview | |||
There was a problem hiding this comment.
Move this all thing in the main README.md Then explain at the end that the rest of documentation is work in progress.
docs/getting-started/preview.md
Outdated
| docker run -e POSTGRES_DB=postgres -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -p 8501:8501 -p 5432:5432 -p 8888:8888 --user root -v $(pwd):/app usc-imsc:w4h-toolkit-preview | ||
| ``` | ||
|
|
||
| ## Accessing the Dashboard |
There was a problem hiding this comment.
all this is very good but we just want a top-level list with each item basic information, links, what it does like for the dashboard link to home allows to do x, link to import allows to do y, ... again this should be in the demo and paper.
|
Please let me know if I should include information about the following:
|
No description provided.