Skip to content

Commit

Permalink
Change capitalization of titles
Browse files Browse the repository at this point in the history
  • Loading branch information
kristian-lange committed Jun 6, 2024
1 parent 58d0c68 commit 4de3bfb
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 38 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Data Privacy and Ethics
title: Data privacy and ethics
slug: /Data-Privacy-and-Ethics.html
sidebar_position: 7
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: JATOS Tryout Server
title: JATOS tryout server
slug: /JATOS-Tryout-Server.html
sidebar_position: 8
---
Expand Down
44 changes: 22 additions & 22 deletions versioned_docs/version-3.9.1/Run_your_study/Manage-Results.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Manage Results
title: Manage results
slug: /Manage-Results.html
sidebar_position: 8
---

## Results Pages
## Results pages

Once you collected data for a study, you can see and manage the results by clicking on one of the *Results* buttons.

Expand All @@ -15,31 +15,31 @@ The image below is an example of a study results page, but there are result page
![Results View screenshot](/img/v39x/results_view_12.png)


## Interacting With The Results Table
## Interacting with the results table

### View Result Data
### View result data

Each study result has an arrow on the left. If you click on it, the result data for this study run will be displayed underneath the row. Since a study can have several components and each component produces its own result data there can be several result data each in its own row (like in the screenshot below). By clicking on _show all_ one can see the whole data if it doesn't fit all in the box.

![Results View screenshot](/img/v39x/results_view_11.png)


### Selecting Results
### Selecting results

There is a checkbox on the left side of each row to select/deselect a specific result. You can also use the buttons on the bar above to select/deselect all results in the table. Additionally you can select only the filtered ones or only the visible ones.

![Results View screenshot](/img/v39x/results_view_13.png)


### Filter Results & Filter Builder
### Filter results & filter builder

The filter lets you search all all fields in the results table (the metadata).

![Results View screenshot](/img/v39x/results_view_14.png)

If you type, for example, "Personal Single" in the *Filter* field, only the results ran by a Personal Single worker will appear on the table. You can then click on *Filtered* to select them and export only those results that you're interested in.

For more eloborate filtering you can use Regular Expressions. Click on *RegEx* to activate this.
For more elaborate filtering you can use Regular Expressions. Click on *RegEx* to activate this.

By default filtering in case insensitive but you can turn on case sensitive filtering by clicking on *Aa*.

Expand All @@ -48,7 +48,7 @@ Sometimes the simple filter is not precise enough or you want to combine multipl
![Results View screenshot](/img/v39x/results_view_15.png)


## Export Results
## Export results

![Results View screenshot](/img/v39x/results_view_16.png)

Expand All @@ -62,56 +62,56 @@ Once you selected the results you're interested in, click *Export Results*. You
Since version 3.8.1 this is the standard export format. It **aggregates result data, result files and result metadata** in one ZIP archive file with a _.jrzip_ file extension ([more information about JRZIP](JATOS-Results-Archive-JRZIP.html)).


### Export Result Data
### Export result data

![Results View screenshot](/img/v39x/results_view_18.png)

The result data are the genuine data that got submitted during study runs without any metadata or result files. You can choose between ***ZIP*** or ***Plain Text*** format. In the _ZIP_ format the result data are stored in a file system structure with folders for study results and component results, similar to the _JRZIP_ format. The _Plain Text_ format is familiar from previous JATOS version: all result data are put together in one text file with one result per line.


### Export Result Files
### Export result files

![Results View screenshot](/img/v39x/results_view_19.png)

The result files are the files that were uploaded during study runs. They are exported as an ZIP archive with a file system structure that represents the study results and their component results.


### Export Result Metadata
### Export result metadata

![Results View screenshot](/img/v39x/results_view_20.png)

The metadata are mostly the data that you see in the result table but that do not belong to the actual result data or files, e.g. worker ID or start time. You can choose between ***JSON*** and ***CSV*** format.


## Delete Results
## Delete results

![Results View screenshot](/img/v39x/results_view_21.png)

You can click *Delete* to remove the selected results. That includes result data, result files and metadata. Keep in mind **there's no undo function for this**.


## Table Columns and Customization
## Table columns and customization

You can show and hide the columns displayed in the table with the drop-down menu under the *Customize* button.

![Results View screenshot](/img/v39x/results_view_22.png)

* **Result ID** - An identifier assigned by JATOS to each study result. A study result is actually a set of component results, each of them with their own (different) *Component Result ID*.
* **UUID** - universally unique identifier - similar to Result ID but this ID is unique over different JATOS installations
* **Study Code** - The study code that was used to start this study run
* **Start Time** - Time at which the first component of the study was started.
* **End Time** - Time at which the last component of the study was finished.
* **Last Seen** - Each component running in a worker's browser sends a "heartbeat" regularly back to JATOS. Last Seen is the time of the last heartbeat received. The heartbeat stops either when the study is finished or when the browser tab is closed. The default period of the heartbeat is 2 minutes but you can change it through a [_jatos.js_ function](jatos.js-Reference.html#jatossetheartbeatperiod).
* **Study code** - The study code that was used to start this study run
* **Start time** - Time at which the first component of the study was started.
* **End time** - Time at which the last component of the study was finished.
* **Last seen** - Each component running in a worker's browser sends a "heartbeat" regularly back to JATOS. Last Seen is the time of the last heartbeat received. The heartbeat stops either when the study is finished or when the browser tab is closed. The default period of the heartbeat is 2 minutes but you can change it through a [_jatos.js_ function](jatos.js-Reference.html#jatossetheartbeatperiod).
* **Duration** - Simply the time difference between the start and end time.
* **Batch** - Name of the batch the worker belongs to.
* **Worker ID** - Assigned by JATOS. Each worker has its own Worker ID. JATOS' admin user will always have Worker ID 1. You can click on a Worker ID to see all the worker's results.
* **Worker Type** - Displays the [Worker type](Worker-Types.html) that ran the study.
* **MTurk Worker ID** - Only applies to studies run by MTurk workers. An identifier given by Amazon Mechanical Turk's, not by JATOS.
* **MTurk Confirmation Code** - Only applies to studies run by MTurk workers. The Confirmation Code is generated by JATOS and given to the worker as proof of his work.
* **Worker type** - Displays the [Worker type](Worker-Types.html) that ran the study.
* **MTurk worker ID** - Only applies to studies run by MTurk workers. An identifier given by Amazon Mechanical Turk's, not by JATOS.
* **MTurk confirmation code** - Only applies to studies run by MTurk workers. The Confirmation Code is generated by JATOS and given to the worker as proof of his work.
* **Group ID** - Only available for group studies. It identifies the group.
* **Files** - Indicates result file upload
* **Data Size** - (Component Results only) - Size of the result data as it is stored in the database
* **Files (Size)** - (Component Results only) - List of the uploaded result files with their size in brackets
* **Data size** - (Component Results only) - Size of the result data as it is stored in the database
* **Files (size)** - (Component Results only) - List of the uploaded result files with their size in brackets
* **State**

Possible states for _study results_ are:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Run your Study with Study Links
title: Run your study with study links
slug: /Run-your-Study-with-Study-Links.html
sidebar_position: 2
---

Study Links in JATOS is the name of a page where one can generate study links for your participants (also called workers in JATOS) to run your study. You can also organize your participants into batches and handle their results there.
_Study Links_ in JATOS is the name of a page where one can generate study links for your participants (also called workers in JATOS) to run your study. You can also organize your participants into batches and handle their results there.

To get to the Study Links page press on the button **Study Links** in your study's page:

Expand Down Expand Up @@ -74,7 +74,7 @@ There are two links that can be toggled by a button: 1) [The 'Open Directly' lin
How to connect to MTurk and add study links is described in its own page: [Connect to Mechanical Turk](Connect-to-Mechanical-Turk.html).


## Study Entry Page
## Study Entry page

A study run can be started in JATOS in slightly different ways:

Expand All @@ -84,12 +84,13 @@ A study run can be started in JATOS in slightly different ways:

**QR codes** can be used instead of study links but they are essentially just another representation of the links (using little black and white rectangles instead of characters).


### Start directly with a study link

If you toggle the Study Link(s) button to 'Open Directly' the generated link will start the study run directly without any intermediate steps like the Study Entry page. The study link has the format `https://my.jatos.server/publix/study-code`, e.g. `https://cortex.jatos.org/publix/GwtCkuCY4bM`. This is fast for the participant but has the disadvantage that if they click the study link accidentally, at least if it is a single-use link (Personal Single or General Single), it will be invalidated and the participant is not allowed to run the study again (not without handing them a new study link).


### Study link + Study Entry page for confirmation
### Study link + study entry page for confirmation

If you toggle the Study Link(s) button to 'Confirm First' the generated link will first show the Study Entry page and only when clicked the '<span class="glyphicon glyphicon-play"></span>' button start the actual study run.

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-3.9.1/Run_your_study/Study-Log.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Study Log
title: Study log
slug: /Study-Log.html
sidebar_position: 10
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Tips & Tricks
title: Tips & tricks
slug: /Tips-and-Tricks.html
sidebar_position: 11
---
Expand Down
12 changes: 6 additions & 6 deletions versioned_docs/version-3.9.1/Run_your_study/Worker-Types.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Worker Types
title: Worker types
slug: /Worker-Types.html
sidebar_position: 3
---
Expand All @@ -25,7 +25,7 @@ Following Amazon Mechanical Turk’s terminology, a worker in JATOS is a person
Jatos workers run a study (or any of its components individually) by clicking on the _Run_ buttons in the GUI. Jatos workers are usually the **researchers trying out their own studies**. Each JATOS user (i.e., anybody with a JATOS login) has their own Jatos worker. They are not meant to be used by participants.


### Personal Single Worker
### Personal Single worker

With a Personal Single study link **a study can be run only once** ([*But see Allow Preview](Restricting-study-flow.html#allow-preview)). You can think of them as _personalized links with single access_. Each Personal Single study link corresponds to a Personal Single worker.

Expand All @@ -34,7 +34,7 @@ Usually you would send a Personal Single study link to workers that you contact
[More about how to generate Personal type study links](Run-your-Study-with-Study-Links.html#personal-type-links)


### Personal Multiple Worker
### Personal Multiple worker

With a Personal Multiple study link the worker can **run a study as many times as they want**. Each Personal Multiple study link corresponds to a Personal Multiple worker.

Expand All @@ -43,7 +43,7 @@ You could send Personal Multiple study links to your pilot workers.
[More about how to generate Personal type study links](Run-your-Study-with-Study-Links.html#personal-type-links)


### General Single Worker
### General Single worker

This study link type can be used **many times by different participants to run a study but only once per browser** ([*But see Allow Preview](Restricting-study-flow.html#allow-preview)). Each time the link is used a new General Single worker is created on-the-fly.

Expand All @@ -52,12 +52,12 @@ You could distribute a General Single study link through social media, like twit
Keep in mind, however, that JATOS uses the browser's cookies to decide whether a study link was already used. If someone uses a different computer, a new browser, or simply deletes their browser's cookies, then JATOS will assume that it's an unused study link. So the same person could (with some effort) use a General Single link several times.


### General Multiple Worker
### General Multiple worker

A General Multiple study link is the least restrictive type and can be used **many times by different participants to run a study**. The difference to a General Single is that the General Multiple study link can be used repeatedly **even in the same browser**. Each time a General Multiple study link is used a new General Multiple worker is created on-the-fly.


### MTurk (Sandbox) Worker
### MTurk (Sandbox) worker

MTurk and MTurk Sandbox workers access a JATOS study through a study link in Amazon's Mechanical Turk (MTurk).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Session Data - Three Types
title: Session data - Three types
slug: /Session-Data-Three-Types.html
sidebar_position: 9
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Write your own Study - Basics and Beyond
title: Write your own study - Basics and beyond
slug: /Write-your-own-Study-Basics-and-Beyond.html
sidebar_position: 2
---
Expand Down

0 comments on commit 4de3bfb

Please sign in to comment.