study-management.rst 11.4 KB
Newer Older
TiG's avatar
TiG committed
1
2
3
4
5
================
Study management
================


Bengfort's avatar
Bengfort committed
6
7
.. _study-create:

Bengfort's avatar
Bengfort committed
8
9
Create a study
==============
TiG's avatar
TiG committed
10

11
1.  Click on **Create new study**
Bengfort's avatar
Bengfort committed
12

Bengfort's avatar
Bengfort committed
13
2.  Fill in all required fields on the page:
Bengfort's avatar
Bengfort committed
14

Bengfort's avatar
Bengfort committed
15
16
17
18
    -   **Name** describes the title of the study you want to create
    -   **Responsible contact person** is the person who can be contacted if
        any questions regarding the study occur
    -   **Principal Investigator** is the lead researcher
19
20
    -   **Phone number** and **E-mail-address** are the contact information at
        which the contact person can be reached
Karolina Mader's avatar
Karolina Mader committed
21

Bengfort's avatar
Bengfort committed
22
23
24
3.  Decide on setting it up as a regular study that includes study recruitment
    and execution or as a **one time invitation**. The option **Is a one time
    invitation** should only be used when you are sure that it is sufficient to
TiG's avatar
TiG committed
25
    invite potential subjects **anonymously** via mail.
Karolina Mader's avatar
Karolina Mader committed
26

TiG's avatar
TiG committed
27
28
29
4.  Fill in any additional information (you can still do that later)

5.  Click on **Save** to record your progress
TiG's avatar
TiG committed
30

TiG's avatar
TiG committed
31
.. warning::
Bengfort's avatar
Bengfort committed
32
33
34
    When choosing option **Is a one time invitation**: Please be aware that
    Castellum will **not** track actual participations or appointments and it
    will **not** provide pseudonyms within the study.
TiG's avatar
TiG committed
35

36
Now you can :ref:`find your study <study-search>` in the studies list.
Karolina Mader's avatar
Karolina Mader committed
37

Karolina Mader's avatar
Karolina Mader committed
38

39
40
41
42
43
44
45
.. _study-sessions:

Set up sessions
---------------

In the **Sessions** tab, you can enter as many test sessions as you like.

Bengfort's avatar
Bengfort committed
46
47
48
-   **Add session**
-   Set up **Start of test sessions** and **End of test sessions**
-   Define general **Session instructions**
49

50
.. note::
TiG's avatar
TiG committed
51
52
53
54
55
56
57
58
59
60
61
62
63
64
    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
TiG's avatar
TiG committed
65
    institute) select a **Resource**
TiG's avatar
TiG committed
66
-   **Additional text for reminder emails** allows you to provide information
TiG's avatar
TiG committed
67
68
69
    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
TiG's avatar
TiG committed
70
71
72
73
74
-   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.
75
76


Bengfort's avatar
Bengfort committed
77
78
.. _study-recruitment-settings:

Bengfort's avatar
Bengfort committed
79
80
Set up the recruitment process
------------------------------
Karolina Mader's avatar
Karolina Mader committed
81

Bengfort's avatar
Bengfort committed
82
83
Castellum offers three features to restrict which subjects are considered for
your study:
Bengfort's avatar
Bengfort committed
84

Bengfort's avatar
Bengfort committed
85
86
87
-   Attribute filters
-   Excluded studies
-   Text based inclusion and exclusion criteria
Karolina Mader's avatar
Karolina Mader committed
88

89
.. note::
TiG's avatar
TiG committed
90
91
92
93
94
95
96
97
98
99
100

    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.

Bengfort's avatar
Bengfort committed
101
1.  Go to the **Recruitment Settings** tab
Karolina Mader's avatar
Karolina Mader committed
102

Bengfort's avatar
Bengfort committed
103
2.  By clicking on **General** the **Recruitment text** will be shown to you.
Karolina Mader's avatar
Karolina Mader committed
104
    You can:
Bengfort's avatar
Bengfort committed
105

Bengfort's avatar
Bengfort committed
106
107
108
109
110
111
112
113
114
    -   edit the **Recruitment text** (this text will be shown to recruiters
        and will be used by them to recruit subjects for your study),
    -   decide whether you wish to set up the **Advanced filtering** (this
        allows you to create multiple filtergroups that are not linked to each
        other),
    -   set the function **Exclusive subjects** (If you select this feature,
        potential subjects for your study cannot be recruited for other
        studies. Please note that this may prevent other researchers from
        finding enough participants.) and
Bengfort's avatar
Bengfort committed
115
    -   decide whether **Complete filter matches only** will be shown to the
Bengfort's avatar
Bengfort committed
116
117
        recruiters of your study or if there will be some subjects displayed,
        in which certain characteristics still have to be queried
Bengfort's avatar
Bengfort committed
118

Bengfort's avatar
Bengfort committed
119
3.  By clicking on **Filter** you are able to set filter criteria
Bengfort's avatar
Bengfort committed
120

TiG's avatar
TiG committed
121
    -   select the attribute that should be used for filtering
Bengfort's avatar
Bengfort committed
122
123
    -   click **Add**
    -   define the filter
Bengfort's avatar
Bengfort committed
124
    -   click **Apply**
Bengfort's avatar
Bengfort committed
125

126
    You may set as many filters as you like.
Bengfort's avatar
Bengfort committed
127

128
    .. note::
TiG's avatar
TiG committed
129
130
131
132
133
134
135
        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.

    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.
Bengfort's avatar
Bengfort committed
136

TiG's avatar
TiG committed
137
138
139
    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.
Bengfort's avatar
Bengfort committed
140

TiG's avatar
TiG committed
141
142
143
144
145
    .. 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**.
Karolina Mader's avatar
Karolina Mader committed
146

Bengfort's avatar
Bengfort committed
147
4.  In **Excluded studies** you can select certain studies in which your
Karolina Mader's avatar
Karolina Mader committed
148
    subjects must not have participated
Bengfort's avatar
Bengfort committed
149

TiG's avatar
TiG committed
150
151
152
153
5.  When you click on **Inclusion/exclusion criteria**, you can add
    **additional subject characteristics that should be verified during the
    recruitment**

154
    .. note::
Bengfort's avatar
Bengfort committed
155

TiG's avatar
TiG committed
156
157
158
159
160
161
        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: <type>** 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.
Bengfort's avatar
Bengfort committed
162

TiG's avatar
TiG committed
163
164
6.  To allow recruiters to send batch invitations via e-mail, proceed as
    follows:
Bengfort's avatar
Bengfort committed
165

166
167
168
    -   click on **Mail Settings**
    -   define an **E-mail subject**
    -   add an **E-mail body**
Bengfort's avatar
Bengfort committed
169

TiG's avatar
TiG committed
170
171
172
173
    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.

174
    .. note::
TiG's avatar
TiG committed
175
176
177

        It is not intended to send e-mail attachments via Castellum. Instead,
        links can be inserted as standard text.
Karolina Mader's avatar
Karolina Mader committed
178

Bengfort's avatar
Bengfort committed
179

Bengfort's avatar
Bengfort committed
180
181
.. _study-domains:

Bengfort's avatar
typos    
Bengfort committed
182
183
Manage study pseudonym domains
------------------------------
Bengfort's avatar
Bengfort committed
184
185
186
187
188
189
190
191

In the **Pseudonym domains** tab you can add a new domain or change the name of
an existing domain.

If there are general domains you can also define which general domains need to
be accessed in the context of this study.


192
193
194
195
.. _study-members:

Manage study members
--------------------
Bengfort's avatar
Bengfort committed
196

TiG's avatar
TiG committed
197
198
If you want to give access to other staff members (e.g. recruiters) for your
study, please follow the steps below.
Bengfort's avatar
Bengfort committed
199

200
1.  Go to the **Member management** tab
Karolina Mader's avatar
Karolina Mader committed
201

Bengfort's avatar
Bengfort committed
202
2.  If you click on the field under **User**, you will be shown all possible
Karolina Mader's avatar
Karolina Mader committed
203
    users to whom you can assign roles
Bengfort's avatar
Bengfort committed
204

Bengfort's avatar
Bengfort committed
205
3.  Select the user who is supposed to take over the recruitment
Karolina Mader's avatar
Karolina Mader committed
206

Bengfort's avatar
Bengfort committed
207
4.  Click on **Add**
Karolina Mader's avatar
Karolina Mader committed
208

Bengfort's avatar
Bengfort committed
209
5.  Click **Manage groups** next to the person you have chosen
Karolina Mader's avatar
Karolina Mader committed
210

Bengfort's avatar
Bengfort committed
211
6.  Select the appropriate roles and click **Save**
TiG's avatar
TiG committed
212

Karolina Mader's avatar
Karolina Mader committed
213
    .. note::
Karolina Mader's avatar
Karolina Mader committed
214

TiG's avatar
TiG committed
215
216
217
        Some features (e.g. recruitment) only become available once the study
        is started. So, some added users may not instantly notice those role
        changes.
Bengfort's avatar
Bengfort committed
218
219


Bengfort's avatar
Bengfort committed
220
221
.. _study-start:

Bengfort's avatar
Bengfort committed
222
223
224
225
226
Start and stop a study
======================

After a study has been created it is still in a draft state. Only Study
Approvers have the permission to start recruitment. Depending on your
Bengfort's avatar
typos    
Bengfort committed
227
organization, there may be different organizational steps such as a review
Bengfort's avatar
Bengfort committed
228
associated with that.
Bengfort's avatar
Bengfort committed
229

Bengfort's avatar
Bengfort committed
230
231
In order to start or stop a study, a Study Approver needs to follow these
steps:
Bengfort's avatar
Bengfort committed
232

233
234
1.  :ref:`Find the study <study-search>` at the **Studies** page, click
    **Details** next to the study you wish to start/stop
Bengfort's avatar
Bengfort committed
235

Bengfort's avatar
Bengfort committed
236
237
238
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.
Bengfort's avatar
Bengfort committed
239

Bengfort's avatar
Bengfort committed
240
241
242
243
244
245
.. warning::

    A study can still be changed after it has been approved and started. The
    tab "Changes" provides an overview of all the settings for a study. Any
    changes that were made since the study was started are highlighted.

Bengfort's avatar
Bengfort committed
246
247
248
249
250
251

.. _study-finish:

Finish a study
==============

252
1.  :ref:`Find the study <study-search>` at the **Studies** page, click
Bengfort's avatar
Bengfort committed
253
    **Details** next to the study you wish to finish/resume.
Bengfort's avatar
Bengfort committed
254

Bengfort's avatar
Bengfort committed
255
256
2.  You can find the button **Finish study** next to the study name near to
    other buttons.
Bengfort's avatar
Bengfort committed
257

Bengfort's avatar
Bengfort committed
258
.. note::
Bengfort's avatar
Bengfort committed
259

Bengfort's avatar
Bengfort committed
260
    All information related to potential subjects who were **not participating** in
TiG's avatar
TiG committed
261
262
263
    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.
Bengfort's avatar
Bengfort committed
264
265
266
267


.. _study-delete:

Bengfort's avatar
Bengfort committed
268
269
Delete a study
==============
Bengfort's avatar
Bengfort committed
270

Bengfort's avatar
Bengfort committed
271
When a study should be deleted depends on the rules of your specific
Bengfort's avatar
typos    
Bengfort committed
272
organization. We assume that it makes sense to delete all study data after few
Bengfort's avatar
typos    
Bengfort committed
273
years, effectively anonymizing the research data.
Bengfort's avatar
Bengfort committed
274

Bengfort's avatar
Bengfort committed
275
276
Once you delete a study from Castellum it is no longer possible to answer to
export or delete requests from subjects. Make sure that all relevant external
Bengfort's avatar
typos    
Bengfort committed
277
has been deleted before you delete a study from Castellum. Then proceed as
Bengfort's avatar
Bengfort committed
278
follows:
Bengfort's avatar
Bengfort committed
279

280
281
1.  :ref:`Find the study <study-search>` at the **Studies** page, click
    **Details**
Bengfort's avatar
Bengfort committed
282

Bengfort's avatar
Bengfort committed
283
2.  Make sure the study is finished (see :ref:`study-finish`)
Bengfort's avatar
Bengfort committed
284

285
286
287
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**
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302


.. _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
Bengfort's avatar
Bengfort committed
303
304
305
306
307
308
309
310
311
312
313


.. _study-filter-trial:

Check whether the database contains enough subjects for your reasearch project
==============================================================================

Click on **Studies** on the front page and then on **Try filters**. You can
now experiment with filters just as in a regular study. The preview will show
you how many subjects in the database match your filters.

TiG's avatar
TiG committed
314
315
316
317
318
319
320
321
.. admonition:: Example

    By the time of writing (September 2021) the MPI for Human Development 
    recommends its Castellum recruiters to aim for at least 10× more potential 
    than required subjects for a smooth recruitment process. Otherwise it 
    becomes essential to populate the database via external sources or efforts 
    first.  

Bengfort's avatar
Bengfort committed
322
323
If you decide you want to keep the set of filters you can go to **Convert to
study** to convert your temporary settings to a regular study.