From 6af89c53255c3798c8f5d8690a1d65a78bf61106 Mon Sep 17 00:00:00 2001 From: Tobias Bengfort Date: Mon, 15 Mar 2021 16:36:00 +0100 Subject: [PATCH 01/12] Reduce redundancy at the start of study guides --- source/guides/study-management.rst | 52 ++++++++++++++---------------- 1 file changed, 24 insertions(+), 28 deletions(-) diff --git a/source/guides/study-management.rst b/source/guides/study-management.rst index f57d899..639794f 100644 --- a/source/guides/study-management.rst +++ b/source/guides/study-management.rst @@ -3,14 +3,7 @@ Create a study ============== -1. Click on **Studies** on the front page - - - By selecting **Mine** in **Membership**, you will see studies you created. - Under the field **All** you can see all studies that have been created. - - In the field **Search** you can look for a certain study - - By choosing a **Status** and / or a Study **Type**, you may also filter studies - -2. Click on **Create new study** +1. Click on **Create new study** 3. Fill in all required fields on the page: @@ -25,7 +18,7 @@ Create a study 5. Click on **Save** to record your progress -Now you can find your study in the list +Now you can :ref:`find your study ` in the studies list. .. _study-sessions: @@ -61,12 +54,6 @@ In order to limit the search for subjects in Castellum, - excluded studies as well as - inclusion and exclusion criteria should be defined. -1. Go to **Studies** on the front page, click **Details** next to the study - you wish to set up filters and criteria for - - If you have already started the study, click on **Stop** on the upper left. - If you did not start it yet, you will be able to edit filters and criteria right away. - 2. Go to the **Recruitment Settings** tab 3. By clicking on **General** the **Recruitment text** will be shown to you. @@ -136,12 +123,7 @@ Manage study members If you want to give access to a person (e.g. a recruiter) for your study, please follow the steps below. -1. Click on **Studies** on the front page - -2. Click on **Details** of the study for which you want to change access rights - or role redistribution - -3. Go to the **Member management** tab +1. Go to the **Member management** tab 4. If you click on the field under **User**, you will be shown all possible users to whom you can assign roles @@ -172,8 +154,8 @@ associated with that. In order to start or stop a study, a Study Approver needs to follow these steps: -1. Go to **Studies** on the front page, click **Details** next to the study - you wish to start/stop. +1. :ref:`Find the study ` at the **Studies** page, click + **Details** next to the study you wish to start/stop 2. You can find the button **Start** in the left upper corner under the study name. By clicking on **Start** you initiate the recruiting process @@ -184,8 +166,8 @@ steps: Finish a study ============== -1. Go to **Studies** on the front page, click **Details** next to the study - you wish to start/stop. +1. :ref:`Find the study ` at the **Studies** page, click + **Details** next to the study you wish to start/stop. 2. You can find the button **Finish study** in the left upper corner under the study name. @@ -212,9 +194,8 @@ export or delete requests from subjects. Make sure that all relevant external has been deleted before you delete a study from Castellum. Then proceed as follows: -1. Go to **Studies** on the front page - -2. Choose the study you want to delete by clicking on **Details** next to it +1. :ref:`Find the study ` at the **Studies** page, click + **Details** 3. Make sure the study is finished (see :ref:`study-finish`) @@ -223,3 +204,18 @@ follows: - Confirm the notice **I have made sure that all external data related to this study has been destroyed** - Click on **Confirm** + + +.. _study-search: + +Find your study +=============== + +Click on **Studies** on the front page + +- By selecting **Mine** in **Membership**, you will see studies you created + or are a member of. Under the field **All** you can see all studies that + have been created. +- In the field **Search** you can look for a certain study +- By choosing a **Status** and / or a Study **Type**, you may also filter + studies -- GitLab From ab51e345aa3571d24f994f9fea11a023fa0e1792 Mon Sep 17 00:00:00 2001 From: Tobias Bengfort Date: Mon, 15 Mar 2021 16:40:58 +0100 Subject: [PATCH 02/12] renumber lists --- source/guides/study-management.rst | 33 +++++++++++++++--------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/source/guides/study-management.rst b/source/guides/study-management.rst index 639794f..1f7918b 100644 --- a/source/guides/study-management.rst +++ b/source/guides/study-management.rst @@ -5,7 +5,7 @@ Create a study 1. Click on **Create new study** -3. Fill in all required fields on the page: +2. Fill in all required fields on the page: - **Name** describes the title of the study you want to create - **Responsible contact person** is the person who can be contacted if @@ -14,9 +14,9 @@ Create a study - **Phone number** and **E-mail-address** are the contact information at which the contact person can be reached -4. Fill in any additional information (you can still do that later) +3. Fill in any additional information (you can still do that later) -5. Click on **Save** to record your progress +4. Click on **Save** to record your progress Now you can :ref:`find your study ` in the studies list. @@ -54,9 +54,9 @@ In order to limit the search for subjects in Castellum, - excluded studies as well as - inclusion and exclusion criteria should be defined. -2. Go to the **Recruitment Settings** tab +1. Go to the **Recruitment Settings** tab -3. By clicking on **General** the **Recruitment text** will be shown to you. +2. By clicking on **General** the **Recruitment text** will be shown to you. You can: - edit the **Recruitment text** (this text will be shown to recruiters @@ -72,7 +72,7 @@ In order to limit the search for subjects in Castellum, recruiters of your study or if there will be some subjects displayed, in which certain characteristics still have to be queried -4. By clicking on **Filter** you are able to set filter criteria +3. By clicking on **Filter** you are able to set filter criteria - select whether you want to create a filter regarding the **First language**, **Highest educational degree**, **Handedness**, **Has hearing aid?**, **Age** @@ -95,16 +95,16 @@ In order to limit the search for subjects in Castellum, This is necessary, for example, if you need subjects both at the age between 20-30 and 50-60. -5. In **Excluded studies** you can select certain studies in which your +4. In **Excluded studies** you can select certain studies in which your subjects must not have participated -6. When you click on **Inclusion/exclusion criteria**, you can add **Additional +5. When you click on **Inclusion/exclusion criteria**, you can add **Additional subject characteristics that should be verified during the recruitment** .. note:: If it is a MRI-study, the criteria are pre-set for checking during recruitment -7. If recruitment is to take place by e-mail, proceed as follows: +6. If recruitment is to take place by e-mail, proceed as follows: - click on **Mail Settings** - define an **E-mail subject** @@ -125,16 +125,16 @@ please follow the steps below. 1. Go to the **Member management** tab -4. If you click on the field under **User**, you will be shown all possible +2. If you click on the field under **User**, you will be shown all possible users to whom you can assign roles -5. Select the user who is supposed to take over the recruitment +3. Select the user who is supposed to take over the recruitment -6. Click on **Add** +4. Click on **Add** -7. Click **Manage groups** next to the person you have chosen +5. Click **Manage groups** next to the person you have chosen -8. Select the appropriate roles and click **Save** +6. Select the appropriate roles and click **Save** .. note:: @@ -197,10 +197,9 @@ follows: 1. :ref:`Find the study ` at the **Studies** page, click **Details** -3. Make sure the study is finished (see :ref:`study-finish`) - -4. Click on **Delete** under the study name +2. Make sure the study is finished (see :ref:`study-finish`) +3. Click on **Delete** under the study name - Confirm the notice **I have made sure that all external data related to this study has been destroyed** - Click on **Confirm** -- GitLab From feea60a0b14abd1cde0d4a9f1fbda80a5b5d918f Mon Sep 17 00:00:00 2001 From: TiG Date: Fri, 12 Mar 2021 09:25:00 +0100 Subject: [PATCH 03/12] remove MPIB specific attributes --- source/guides/study-management.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/source/guides/study-management.rst b/source/guides/study-management.rst index 1f7918b..1ead01c 100644 --- a/source/guides/study-management.rst +++ b/source/guides/study-management.rst @@ -74,9 +74,7 @@ In order to limit the search for subjects in Castellum, 3. By clicking on **Filter** you are able to set filter criteria - - select whether you want to create a filter regarding the **First language**, - **Highest educational degree**, **Handedness**, **Has hearing aid?**, **Age** - or **Sex** + - select the attribute that should be used for filtering - click **Add**, - define the filter and - click **Apply** -- GitLab From a2d02b9dba8cf1a36b32b3b329fbc285245d0728 Mon Sep 17 00:00:00 2001 From: Tobias Bengfort Date: Mon, 15 Mar 2021 16:54:05 +0100 Subject: [PATCH 04/12] avoid lists that are sentences --- source/guides/study-management.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/source/guides/study-management.rst b/source/guides/study-management.rst index 1ead01c..10257ad 100644 --- a/source/guides/study-management.rst +++ b/source/guides/study-management.rst @@ -28,10 +28,9 @@ Set up sessions In the **Sessions** tab, you can enter as many test sessions as you like. -- Define **Session instructions**, -- **Start of test sessions**, -- **End of test sessions** and -- Click on **Add session** +- **Add session** +- Set up **Start of test sessions** and **End of test sessions** +- Define general **Session instructions** - When adding a test session, always give the session a **Name** and specify the **Duration of a session in minutes** @@ -48,11 +47,12 @@ In the **Sessions** tab, you can enter as many test sessions as you like. Set up the recruitment process ------------------------------ -In order to limit the search for subjects in Castellum, +Castellum offers three features to restrict which subjects are considered for +your study: -- filters, -- excluded studies as well as -- inclusion and exclusion criteria should be defined. +- Attribute filters +- Excluded studies +- Text based inclusion and exclusion criteria 1. Go to the **Recruitment Settings** tab @@ -75,8 +75,8 @@ In order to limit the search for subjects in Castellum, 3. By clicking on **Filter** you are able to set filter criteria - select the attribute that should be used for filtering - - click **Add**, - - define the filter and + - click **Add** + - define the filter - click **Apply** You may set as many filters as you like. -- GitLab From d9b8a05dec23d6c28f9ed6e9ff13433d3255a3ef Mon Sep 17 00:00:00 2001 From: Tobias Bengfort Date: Mon, 15 Mar 2021 16:58:52 +0100 Subject: [PATCH 05/12] avoid spacial references --- source/guides/study-management.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/source/guides/study-management.rst b/source/guides/study-management.rst index 10257ad..8f3dbc0 100644 --- a/source/guides/study-management.rst +++ b/source/guides/study-management.rst @@ -155,8 +155,9 @@ steps: 1. :ref:`Find the study ` at the **Studies** page, click **Details** next to the study you wish to start/stop -2. You can find the button **Start** in the left upper corner under the study - name. By clicking on **Start** you initiate the recruiting process +2. You can find the button **Start** near to the study name. By clicking on + **Start** you initiate the recruiting process. Started studies will offer a + stop button instead to stop (or pause) recruitment. .. _study-finish: @@ -167,8 +168,8 @@ Finish a study 1. :ref:`Find the study ` at the **Studies** page, click **Details** next to the study you wish to start/stop. -2. You can find the button **Finish study** in the left upper corner under the study - name. +2. You can find the button **Finish study** next to the study name near to + other buttons. .. note:: -- GitLab From b22bee26e9bdc72318766cc00fec51841bb4707b Mon Sep 17 00:00:00 2001 From: TiG Date: Fri, 12 Mar 2021 09:59:26 +0100 Subject: [PATCH 06/12] revise session set up --- source/guides/study-management.rst | 31 ++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/source/guides/study-management.rst b/source/guides/study-management.rst index 8f3dbc0..32c80d5 100644 --- a/source/guides/study-management.rst +++ b/source/guides/study-management.rst @@ -32,14 +32,29 @@ In the **Sessions** tab, you can enter as many test sessions as you like. - Set up **Start of test sessions** and **End of test sessions** - Define general **Session instructions** -- When adding a test session, always give the session a **Name** and specify - the **Duration of a session in minutes** -- Select the **Type** of the session and press **Add session** -- By clicking on the **Delete** button, you can delete any test session - you created -- Click on **Update** to go to Session details. If your institute uses the - external scheduler to schedule appointments, you can enable it here - (see this guide: :ref:`set-up-external-scheduler`) +.. hint:: + In **Session Instructions** you can inform recruiters on + conditions/requirements that may be important for or in between sessions. + For example, recruiters are often asked to ensure a certain time interval + between session appointments. This would be explained here. + + **Start** and **End of test sessions** allows Castellum to offer an + approximate overview schedule of all studies in Calendar view at Study + management. + +When adding a test session: + +- Always give the session a **Name** and specify the **Duration of a session + in minutes** (duration will be used for appointment booking) +- Additionally, select the **Type** of the session and (if applicable at your + institute) select a **Ressource** +- **Additional text for reminder emails** allows you to provide information + to subjects prior to the actual appointment +- If your institute uses the external scheduler to schedule appointments, you + can enable it here (see :ref:`set-up-external-scheduler`) + +For existing sessions a **Delete** button allows you to delete any test session +you created. Click on **Update** to review or edit session details. .. _study-recruitment-settings: -- GitLab From c76108efcce6de5baa6c6bf0e12c0b5468f71c4d Mon Sep 17 00:00:00 2001 From: TiG Date: Fri, 12 Mar 2021 10:04:51 +0100 Subject: [PATCH 07/12] add description for test mail option --- source/guides/study-management.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/guides/study-management.rst b/source/guides/study-management.rst index 32c80d5..96f745b 100644 --- a/source/guides/study-management.rst +++ b/source/guides/study-management.rst @@ -49,7 +49,9 @@ When adding a test session: - Additionally, select the **Type** of the session and (if applicable at your institute) select a **Ressource** - **Additional text for reminder emails** allows you to provide information - to subjects prior to the actual appointment + to subjects prior to the actual appointment. You can send yourself a test + mail to check the appearance of session reminders by using the + corresponding button - If your institute uses the external scheduler to schedule appointments, you can enable it here (see :ref:`set-up-external-scheduler`) -- GitLab From 8a6c54f16655254381bb6b8bf1215ea800874ee2 Mon Sep 17 00:00:00 2001 From: TiG Date: Fri, 12 Mar 2021 14:41:46 +0100 Subject: [PATCH 08/12] rewrite of recruitment settings --- source/guides/study-management.rst | 66 ++++++++++++++++++++++-------- 1 file changed, 49 insertions(+), 17 deletions(-) diff --git a/source/guides/study-management.rst b/source/guides/study-management.rst index 96f745b..c8f05d1 100644 --- a/source/guides/study-management.rst +++ b/source/guides/study-management.rst @@ -71,6 +71,18 @@ your study: - Excluded studies - Text based inclusion and exclusion criteria +.. hint:: + + At first it may be unclear how to distinguish **attribute filters** and + **inclusion/exclusion criteria**: + + - Attribute filters are applied to subject attributes stored in + Castellum. In other words, this will only suggest matching potential + subjects in recruitment. + - Inclusion and exclusion criteria need to be used when there is no data + available about it in Castellum. Therefore, they must be checked by a + staff member explicitly during recruitment. + 1. Go to the **Recruitment Settings** tab 2. By clicking on **General** the **Recruitment text** will be shown to you. @@ -97,37 +109,57 @@ your study: - click **Apply** You may set as many filters as you like. - If you wish to create more than one filter group, proceed as follows: - - click on **General**, - - select **Advanced filtering** and - - click on **Save** + .. hint:: + Please note that **all filter criteria** set up within this filter + group have to be **fulfilled**. This also means that opposing filters + would result in an empty set. - When you click on **Add new** in **Filters**, you are able to set another - filter group with specific filters + Sometimes you need to define more than one mutually exclusive group of + suitable subjects. For this, you have to set up **advanced filtering** in + general recruitment settings to create various filter groups. - .. note:: - This is necessary, for example, if you need subjects both at the age between - 20-30 and 50-60. + Subsequently, when you click on **Add new** in **Filters**, you are able to + set another filter group with specific filters. Alternatively, you could + duplicate an existing filter group and edit it afterwards. + + .. admonition:: Example + + This is necessary if you need subjects both at the age between 20-30 + and 50-60. Again, note the distinction between **Any of these** and + **All of these**. 4. In **Excluded studies** you can select certain studies in which your subjects must not have participated -5. When you click on **Inclusion/exclusion criteria**, you can add **Additional - subject characteristics that should be verified during the recruitment** +5. When you click on **Inclusion/exclusion criteria**, you can add + **additional subject characteristics that should be verified during the + recruitment** - .. note:: - If it is a MRI-study, the criteria are pre-set for checking during recruitment + .. hint:: + + Session types may come with specific criteria that have to be checked + every time before appointing subjects to a session. In this case, + you'll see a caret with a label **Criteria for: ** next to the + text field. Clicking on it will show you the text that is always + appended. In other words: You don't have to write this type specific + text by yourself. -6. If recruitment is to take place by e-mail, proceed as follows: +6. To allow recruiters to send batch invitations via e-mail, proceed as + follows: - click on **Mail Settings** - define an **E-mail subject** - add an **E-mail body** - .. note:: - It is not intended to send attachments in the first e-mail via Castellum. - Instead, links can be inserted. + This e-mail will be sent by recruiters at study recruitment by specifying + the amount of recipients. Yet, you can check the appearance of the set up + mail by sending a test mail to yourself with corresponding button. + + .. hint:: + + It is not intended to send e-mail attachments via Castellum. Instead, + links can be inserted as standard text. .. _study-members: -- GitLab From b1b43f4a9603a586840982b9a541c0433a77a2ea Mon Sep 17 00:00:00 2001 From: TiG Date: Fri, 12 Mar 2021 14:52:48 +0100 Subject: [PATCH 09/12] minor changes to member management --- source/guides/study-management.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/source/guides/study-management.rst b/source/guides/study-management.rst index c8f05d1..42a5504 100644 --- a/source/guides/study-management.rst +++ b/source/guides/study-management.rst @@ -167,8 +167,8 @@ your study: Manage study members -------------------- -If you want to give access to a person (e.g. a recruiter) for your study, -please follow the steps below. +If you want to give access to other staff members (e.g. recruiters) for your +study, please follow the steps below. 1. Go to the **Member management** tab @@ -185,7 +185,9 @@ please follow the steps below. .. note:: - Some features (e.g. recruitment) only become available once the study is started. + Some features (e.g. recruitment) only become available once the study + is started. So, some added users may not instantly notice those role + changes. .. _study-start: -- GitLab From 89e9af8a4494ed31aa0fa54abf0bd07ad7b24fe5 Mon Sep 17 00:00:00 2001 From: TiG Date: Fri, 12 Mar 2021 15:10:47 +0100 Subject: [PATCH 10/12] revise finish study --- source/guides/study-management.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/guides/study-management.rst b/source/guides/study-management.rst index 42a5504..dac51b3 100644 --- a/source/guides/study-management.rst +++ b/source/guides/study-management.rst @@ -224,10 +224,10 @@ Finish a study .. note:: - All information related to potential subjects that were not invited to the - study will be deleted when the study is finished. If you finish and then - resume a study, it is possible that subjects that were already found to be - unsuitable are proposed again. + All information related to potential subjects who were **not invited** to + the study will be deleted when the study is finished. Hence, if you finish + and then resume a study, it is possible that subjects that were already + found to be unsuitable are suggested again as potential subjects. .. _study-delete: -- GitLab From 04e0417399854e690727c00fdd8e4d6f34e3c362 Mon Sep 17 00:00:00 2001 From: TiG Date: Fri, 12 Mar 2021 15:16:28 +0100 Subject: [PATCH 11/12] revise study delete --- source/guides/study-management.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/source/guides/study-management.rst b/source/guides/study-management.rst index dac51b3..b01bca5 100644 --- a/source/guides/study-management.rst +++ b/source/guides/study-management.rst @@ -251,8 +251,7 @@ follows: 3. Click on **Delete** under the study name - Confirm the notice **I have made sure that all external data related to - this study has been destroyed** - - Click on **Confirm** + this study has been destroyed** by clicking on **Confirm** .. _study-search: -- GitLab From 5c48e3bfdc35d1e75fa2e5293dd4dece6a13860a Mon Sep 17 00:00:00 2001 From: Tobias Bengfort Date: Mon, 15 Mar 2021 17:34:41 +0100 Subject: [PATCH 12/12] use notes instead of hints for tangential information --- source/guides/study-management.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/source/guides/study-management.rst b/source/guides/study-management.rst index b01bca5..baca3f5 100644 --- a/source/guides/study-management.rst +++ b/source/guides/study-management.rst @@ -32,7 +32,7 @@ In the **Sessions** tab, you can enter as many test sessions as you like. - Set up **Start of test sessions** and **End of test sessions** - Define general **Session instructions** -.. hint:: +.. note:: In **Session Instructions** you can inform recruiters on conditions/requirements that may be important for or in between sessions. For example, recruiters are often asked to ensure a certain time interval @@ -71,7 +71,7 @@ your study: - Excluded studies - Text based inclusion and exclusion criteria -.. hint:: +.. note:: At first it may be unclear how to distinguish **attribute filters** and **inclusion/exclusion criteria**: @@ -110,7 +110,7 @@ your study: You may set as many filters as you like. - .. hint:: + .. note:: Please note that **all filter criteria** set up within this filter group have to be **fulfilled**. This also means that opposing filters would result in an empty set. @@ -136,7 +136,7 @@ your study: **additional subject characteristics that should be verified during the recruitment** - .. hint:: + .. note:: Session types may come with specific criteria that have to be checked every time before appointing subjects to a session. In this case, @@ -156,7 +156,7 @@ your study: the amount of recipients. Yet, you can check the appearance of the set up mail by sending a test mail to yourself with corresponding button. - .. hint:: + .. note:: It is not intended to send e-mail attachments via Castellum. Instead, links can be inserted as standard text. @@ -249,9 +249,9 @@ follows: 2. Make sure the study is finished (see :ref:`study-finish`) -3. Click on **Delete** under the study name - - Confirm the notice **I have made sure that all external data related to - this study has been destroyed** by clicking on **Confirm** +3. Click on **Delete** under the study name. Confirm the notice **I have made + sure that all external data related to this study has been destroyed** by + clicking on **Confirm** .. _study-search: -- GitLab