Skip to content

Commit bbf367d

Browse files
committed
Align wording with Study Manager
1 parent 208e3c6 commit bbf367d

4 files changed

Lines changed: 21 additions & 21 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# CARWatch Web
1+
# Study Manager
22

33
**Get the Android app on the Play Store:**
44
[![Google Play](https://img.shields.io/badge/Google%20Play-CARWatch-3DDC84?logo=google-play&logoColor=white)](https://play.google.com/store/apps/details?id=de.fau.cs.mad.carwatch)
55

66
CARWatch is an open-source framework to support **objective** and **low-cost** assessment of cortisol samples in real-world, unsupervised environments. It is especially suitable for **cortisol awakening response (CAR)** research, but not limited to this application.
77

88
It consists of an [Android application](https://github.com/mad-lab-fau/carwatch-app) that schedules sampling times and tracks
9-
them by scanning a barcode on the respective sampling tube as well as a [web app](https://carwatch-tools.github.io/study-manager/) that provides tools to
10-
**configure studies** and **prepare the study materials** and to **process the log data** recorded by the app.
9+
them by scanning a barcode on the respective sampling tube as well as [Study Manager](https://carwatch-tools.github.io/study-manager/), a web-based tool for
10+
**study preparation**, **study material generation**, and **post-study log processing**.
1111
Alternatively, users with programming experience can use the corresponding [Python package](https://github.com/mad-lab-fau/carwatch-python/) that provides the same range of functionality.
1212

1313
## Features
@@ -25,25 +25,25 @@ This includes:
2525
* Generating a QR-Code for the [CARWatch app](https://github.com/mad-lab-fau/carwatch-app) to automatically set up
2626
the study in the app
2727

28-
2. **Creating printable labels with barcodes for objective sampling time assessment.**
28+
2. **Creating printable labels with barcodes for objective sampling time assessment.**
2929
This includes:
3030
* Customizing the numer of saliva samples per day, the number of days, and the number of study participants
3131
* Adding an optional evening saliva sample
3232
* Customize barcodes to fit your printable label templates
3333

34-
3. **Analyzing the CARWatch log data.**
34+
3. **Processing CARWatch log data.**
3535
This includes:
3636
* Extracting the sampling timestamps from the log data
3737
* Extracting the self-reported awakening times (if available)
3838

3939
## Usage
4040

41-
Simply visit the [CARWatch Website](https://carwatch-tools.github.io/study-manager/) and follow the instructions to get started. It works for all common modern browsers. In particular, it has been extensively tested for Chrome and Firefox. All calculations are performed locally in your browser and no data is sent to a server. Thus, we are not collecting any data from you.
41+
Simply visit [Study Manager](https://carwatch-tools.github.io/study-manager/) and follow the instructions to get started. It works in all common modern browsers. In particular, it has been extensively tested in Chrome and Firefox. All calculations are performed locally in your browser and no data is sent to a server.
4242

4343
## Developer Guide
4444

45-
`study-manager` is a web app based on the [SvelteKit](https://kit.svelte.dev/) framework. It is written in TypeScript and uses [Tailwind CSS](https://tailwindcss.com/) and [Skeleton](https://www.skeleton.dev/) for styling.
46-
If you are a developer and want to contribute to `carwatch` you can install an editable version of the package from
45+
`study-manager` is the CARWatch web interface for study preparation and post-study log processing. It is based on [SvelteKit](https://kit.svelte.dev/), written in TypeScript, and uses [Tailwind CSS](https://tailwindcss.com/) and [Skeleton](https://www.skeleton.dev/) for styling.
46+
If you are a developer and want to contribute to CARWatch, you can install an editable version of the package from
4747
a local copy of the repository.
4848

4949
### Installation
@@ -89,9 +89,9 @@ You can preview the production build with `npm run preview`.
8989
This project is licensed under the MIT License. See the LICENSE file for details.
9090

9191

92-
## Citing carwatch
92+
## Citing CARWatch
9393

94-
If you use `study-manager` in your work, please report the version you used in the text. Additionally, please also cite [our paper](https://www.sciencedirect.com/science/article/abs/pii/S0306453023000513?via%3Dihub) published in Psychoneuroendocrinology:
94+
If you use `study-manager` in your work, please report the version you used in the text. Additionally, please cite [our paper](https://www.sciencedirect.com/science/article/abs/pii/S0306453023000513?via%3Dihub) published in Psychoneuroendocrinology:
9595

9696
```
9797
Richer, R., Abel, L., Küderle, A., Eskofier, B. M., & Rohleder, N. (2023). CARWatch – A smartphone application for

‎src/lib/components/general/Footer.svelte‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div class="page-footer border-t border-surface-500/10 text-xs md:text-base print:hidden">
22
<div class="w-full p-4 gap-x-4 py-4 md:py-8" style="display: flex; justify-content: flex-end">
33
<div>
4-
<a class="btn variant-soft-primary" href="https://github.com/carwatch-tools/carwatch-tools.github.io" target="_blank" rel="noreferrer">
4+
<a class="btn variant-soft-primary" href="https://github.com/carwatch-tools/study-manager" target="_blank" rel="noreferrer">
55
<span>
66
<!-- github logo -->
77
<svg
@@ -13,12 +13,12 @@
1313
d="M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z" />
1414
</svg>
1515
</span>
16-
<span class="hidden md:inline-block ml-2">Github</span>
16+
<span class="hidden md:inline-block ml-2">GitHub</span>
1717
</a>
1818
</div>
1919

2020
<div>
21-
<a class="btn variant-soft-primary" href="https://www.mad.tf.fau.de/person/robert-richer/" target="_blank" rel="noreferrer">
21+
<a class="btn variant-soft-primary" href="https://richrobe.github.io/" target="_blank" rel="noreferrer">
2222
<span class="material-symbols-outlined">
2323
contact_support
2424
</span>

‎src/routes/+layout.svelte‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
</AppRailAnchor>
2323
<AppRailAnchor href="{base}/preparation" selected={$page.route.id === '/preparation'}>
2424
<svelte:fragment slot="lead"><span class="material-symbols-outlined">groups</span></svelte:fragment>
25-
<span>Study Configurator</span>
25+
<span>Study Manager</span>
2626
</AppRailAnchor>
2727
<AppRailAnchor href="{base}/postprocessing" selected={$page.route.id === '/postprocessing'}>
2828
<svelte:fragment slot="lead"><span class="material-symbols-outlined">insert_chart</span></svelte:fragment>

‎src/routes/+page.svelte‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141

4242
<div class="grid grid-cols-3 gap-4 md:gap-10 items-center justify-items-center h-screen">
4343
<div class="flex flex-col col-span-2 row-span-3 items-center xl:items-start text-center xl:text-left space-y-4">
44-
<h1 class="!text-5xl md:!text-6xl max-w-[800px]">Welcome to <br> CARWatch!</h1>
44+
<h1 class="!text-5xl md:!text-6xl max-w-[800px]">Welcome to <br> CARWatch Study Manager</h1>
4545
<p class="!text-xl max-w-[675px]">
4646
<b>CARWatch is a free open-source framework to support the objective and low-cost assessment of biomarker samples in real-world environments.</b>
4747
</p>
@@ -55,15 +55,15 @@
5555
<span class="mr-6">&#129404;</span>Suitable for lab-based biomarker collection
5656
</p>
5757
<p class="!text-xl max-w-[675px]">
58-
<span class="mr-6">&#9989;</span>Supports study preparation, data collection & postprocessing
58+
<span class="mr-6">&#9989;</span>Supports study preparation, data collection, and post-study log processing
5959
</p>
6060
<div class="flex gap-8">
6161
<a href="{base}/preparation" class="btn variant-filled-primary">
62-
<span class="text-xl">Configure Your Study</span>
62+
<span class="text-xl">Open Study Manager</span>
6363
<i class="fa-solid fa-arrow-right-long" />
6464
</a>
6565
<a href="{base}/postprocessing" class="btn variant-filled-primary">
66-
<span class="text-xl">Analyze your Data</span>
66+
<span class="text-xl">Process Study Logs</span>
6767
<i class="fa-solid fa-arrow-right-long" />
6868
</a>
6969
</div>
@@ -91,13 +91,13 @@
9191
</span>
9292
</svelte:fragment>
9393
<svelte:fragment slot="summary">
94-
<h3 class="h3">Straightforward study setup</h3>
94+
<h3 class="h3">Study preparation</h3>
9595
</svelte:fragment>
9696
<svelte:fragment slot="content">
9797
<div>
9898
<ul class="list">
9999
<li><span>&#8226;</span>
100-
<span class="flex-auto">Straightforward study setup</span>
100+
<span class="flex-auto">Study preparation in the browser</span>
101101
</li>
102102
<li><span>&#8226;</span>
103103
<span class="flex-auto">Customize study properties to your needs</span>
@@ -171,7 +171,7 @@
171171
</span>
172172
</svelte:fragment>
173173
<svelte:fragment slot="summary">
174-
<h3 class="h3">Analyze CARWatch log data</h3>
174+
<h3 class="h3">Process CARWatch log data</h3>
175175
</svelte:fragment>
176176
<svelte:fragment slot="content">
177177
<ul class="list">

0 commit comments

Comments
 (0)