From bc662f2eba7a0e32969afaa239dbacab9c59c596 Mon Sep 17 00:00:00 2001 From: TiG Date: Wed, 22 Sep 2021 08:47:59 +0200 Subject: [PATCH 1/8] initial file structure --- source/guides/study-execution.rst | 10 ++++++++++ source/index.rst | 1 + 2 files changed, 11 insertions(+) create mode 100644 source/guides/study-execution.rst diff --git a/source/guides/study-execution.rst b/source/guides/study-execution.rst new file mode 100644 index 0000000..915ed34 --- /dev/null +++ b/source/guides/study-execution.rst @@ -0,0 +1,10 @@ +.. _study-execution: + +=============== +Study execution +=============== + +Study execution lists all particpating subjects of a list. Most importantly it +allows you to obtain pseudonyms for each participant as described here: +:ref:`subject-get-pseudonym`. + diff --git a/source/index.rst b/source/index.rst index 53c4656..3ca4b47 100644 --- a/source/index.rst +++ b/source/index.rst @@ -23,6 +23,7 @@ Welcome to Castellum's documentation! guides/two-factor-authentication guides/subject-management guides/study-management + guides/study-execution guides/pseudonyms guides/data-protection -- GitLab From 9e3fe3443ea7792fcf067bb30fb72126ff9cd9dd Mon Sep 17 00:00:00 2001 From: TiG Date: Wed, 22 Sep 2021 09:30:47 +0200 Subject: [PATCH 2/8] add conductor annotations --- source/guides/study-execution.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/source/guides/study-execution.rst b/source/guides/study-execution.rst index 915ed34..2a7860f 100644 --- a/source/guides/study-execution.rst +++ b/source/guides/study-execution.rst @@ -8,3 +8,22 @@ Study execution lists all particpating subjects of a list. Most importantly it allows you to obtain pseudonyms for each participant as described here: :ref:`subject-get-pseudonym`. + +.. _execution-annotations: + +Conductor Annotations on participants +===================================== + +The participant details in study execution allow you to add additional hints +that may be important for you or other conductors when working with this +participant. The **Hints** tab offers you + +- to specify the interest in future study outcomes. All interescted participants + can be contacted later via the **News** tab in study execution. +- to assign a conductor who should be working with the participant. +- select **Execution tags** that may help to comply with processes or similar. + If the standard tags are not sufficient for your workflow click on + **Manage tags** to add, edit or delete them. +- mark the participant as unreliable. This information will be used for future + study recruitments or study executions allowing other Castellum users to + assess a potential subject and take precautions if necessary. -- GitLab From d282c1d2dd3d31dbf8617092dfff63d00da3e4a4 Mon Sep 17 00:00:00 2001 From: TiG Date: Wed, 22 Sep 2021 14:08:59 +0200 Subject: [PATCH 3/8] complete overview on study execution --- source/guides/study-execution.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/source/guides/study-execution.rst b/source/guides/study-execution.rst index 2a7860f..e9c9beb 100644 --- a/source/guides/study-execution.rst +++ b/source/guides/study-execution.rst @@ -8,6 +8,25 @@ Study execution lists all particpating subjects of a list. Most importantly it allows you to obtain pseudonyms for each participant as described here: :ref:`subject-get-pseudonym`. +The **List** tab simply shows all participants regardless of whether they have +an appointment. For each entry it will present a color coded reliability score, +the appointment states and assigned tags. The **Calendar** tab allows you to +view all participants with appointments (week, month and list views). The +**By pseudonym** tab offers a search for participants by specifying study +specific pseudonyms (see :ref:`subject-by-pseudonym`). + +The **News** tab offers a mail form to contact all interested participants on +recent study outcomes, study specific events or similar. After sending such a +message and if applicable Castellum will send you an additional mail that +lists all participants who want to be informed via postal mail. + +The **Tags** tab allows you to edit, add or delete tags that should be used to +tag participants during study execution in order to support your workflows or +the like. + +The **Progress** tab gives insights on the current number of participants and +appointments. + .. _execution-annotations: -- GitLab From 292a83744dabf920d106dffdc934cf234ec01693 Mon Sep 17 00:00:00 2001 From: TiG Date: Wed, 22 Sep 2021 15:27:38 +0200 Subject: [PATCH 4/8] add attributes export --- source/guides/study-execution.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/source/guides/study-execution.rst b/source/guides/study-execution.rst index e9c9beb..23b510f 100644 --- a/source/guides/study-execution.rst +++ b/source/guides/study-execution.rst @@ -28,6 +28,34 @@ The **Progress** tab gives insights on the current number of participants and appointments. +.. _execution-attribute-export: + +Export attributes of participants +================================= + +You may want to initially populate your scientific data with a listing of +known attributes of the participants. Therefore, Castellum allows you to export +attributes of all participants sorted by a pseudonym. + +.. note:: + + This feature only allows to export those attributes that are specified in + study management as **Exportable recruitment attributes**. + + You are only allowed to export attributes if your privacy level is matching + those of the *highest rated* attribute and/or participant. + + If there is more than one study specific pseudonym domain set up in study + management you will have to select the domain that should be used for export. + +The export will provide a zipped file containing of an attributes file and a +schema file that allows you to comprehend the actual values in the attributes +file. Depending on your Castellum setup the attributes file will be provided +as custom ``json`` or ``tsv`` (as +`BIDS compliant participants file `_ +) file. + + .. _execution-annotations: Conductor Annotations on participants -- GitLab From 7d78eb3d192951434787f34ea86b845e16e6dcc6 Mon Sep 17 00:00:00 2001 From: TiG Date: Wed, 22 Sep 2021 16:15:09 +0200 Subject: [PATCH 5/8] resolve comments --- source/guides/study-execution.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/source/guides/study-execution.rst b/source/guides/study-execution.rst index 23b510f..cb7b5a9 100644 --- a/source/guides/study-execution.rst +++ b/source/guides/study-execution.rst @@ -4,7 +4,8 @@ Study execution =============== -Study execution lists all particpating subjects of a list. Most importantly it +Study execution provides you with a set of features needed to conduct a study. +Foremost, it lists all particpating subjects of a study. Most importantly it allows you to obtain pseudonyms for each participant as described here: :ref:`subject-get-pseudonym`. @@ -12,7 +13,7 @@ The **List** tab simply shows all participants regardless of whether they have an appointment. For each entry it will present a color coded reliability score, the appointment states and assigned tags. The **Calendar** tab allows you to view all participants with appointments (week, month and list views). The -**By pseudonym** tab offers a search for participants by specifying study +**By pseudonym** tab offers to find a participant by specifying study specific pseudonyms (see :ref:`subject-by-pseudonym`). The **News** tab offers a mail form to contact all interested participants on -- GitLab From 4abb2b81407f3a102b9d113cfa0bc3e1fbf1c3fd Mon Sep 17 00:00:00 2001 From: TiG Date: Wed, 22 Sep 2021 16:16:08 +0200 Subject: [PATCH 6/8] fix typos --- source/guides/study-execution.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/guides/study-execution.rst b/source/guides/study-execution.rst index cb7b5a9..c61ebc1 100644 --- a/source/guides/study-execution.rst +++ b/source/guides/study-execution.rst @@ -5,7 +5,7 @@ Study execution =============== Study execution provides you with a set of features needed to conduct a study. -Foremost, it lists all particpating subjects of a study. Most importantly it +Foremost, it lists all participating subjects of a study. Most importantly it allows you to obtain pseudonyms for each participant as described here: :ref:`subject-get-pseudonym`. @@ -66,7 +66,7 @@ The participant details in study execution allow you to add additional hints that may be important for you or other conductors when working with this participant. The **Hints** tab offers you -- to specify the interest in future study outcomes. All interescted participants +- to specify the interest in future study outcomes. All interested participants can be contacted later via the **News** tab in study execution. - to assign a conductor who should be working with the participant. - select **Execution tags** that may help to comply with processes or similar. -- GitLab From b1089d857f3d1d08d395ce2f83900a18ee9df0de Mon Sep 17 00:00:00 2001 From: TiG Date: Fri, 24 Sep 2021 08:57:23 +0200 Subject: [PATCH 7/8] smooth out opening paragraph --- source/guides/study-execution.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/guides/study-execution.rst b/source/guides/study-execution.rst index c61ebc1..59b99d4 100644 --- a/source/guides/study-execution.rst +++ b/source/guides/study-execution.rst @@ -5,7 +5,7 @@ Study execution =============== Study execution provides you with a set of features needed to conduct a study. -Foremost, it lists all participating subjects of a study. Most importantly it +For a start, it lists all participating subjects of a study. Most importantly it allows you to obtain pseudonyms for each participant as described here: :ref:`subject-get-pseudonym`. -- GitLab From 3bb8f18457295032eb2e445bd9aa9b303b770da9 Mon Sep 17 00:00:00 2001 From: TiG Date: Fri, 24 Sep 2021 09:08:59 +0200 Subject: [PATCH 8/8] add warning on potential pitfalls in assignments --- source/guides/study-execution.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/source/guides/study-execution.rst b/source/guides/study-execution.rst index 59b99d4..2fd449c 100644 --- a/source/guides/study-execution.rst +++ b/source/guides/study-execution.rst @@ -69,6 +69,13 @@ participant. The **Hints** tab offers you - to specify the interest in future study outcomes. All interested participants can be contacted later via the **News** tab in study execution. - to assign a conductor who should be working with the participant. + + .. warning:: + In case you have study members who are recruiter and conductor: Please note + that assignments are context aware. In other words assigned recruiters will + not be automatically marked as assigned conductors in the study execution + and vice versa. + - select **Execution tags** that may help to comply with processes or similar. If the standard tags are not sufficient for your workflow click on **Manage tags** to add, edit or delete them. -- GitLab