Collecting data from participants¶
An signalbox.models.Observation represents an occasion on which a measurement can be taken.
A signalbox.models.Reply collates a set of responses made for an Observation, on a single occasion.
Multiple replies can therefore be made for a single Observations. There may happen when:
- A participant does not complete a questionnaire in one session, but returns to complete the observation by clicking in a link in an email in a second session.
- Where researchers are entering paper data, and wish to enter it twice for validation.
Where multiple replies are made for an observation it is important to distinguish which should be used — i.e. exported for later analysis. In exported data the canonical_reply variable indicates which row should be preferred for analysis.
If no Reply has been marked as canonical, multiple replies can be exported with none of them marked as canonical.
The is_canonical_reply field on the Reply determines whether a reply should be considered canonical. The signalbox.models.Observation.canonical_reply() method returns the canonical reply for a given Observation and is used when exporting data.
Marking replies as canonical¶
Researchers can identify which reply should be considered canonical, using the view at: /admin/signalbox/resolve/duplicate/replies/(study_id). This can be accessed from the admin page for each study.
It’s probably best to keep on top of duplicate replies as they arise — resolving which was the correct response a long time after the event might be difficult, or impossible.
Entering data on behalf of someone else¶
Sometimes participants won’t be able to enter data for themselves, and researchers will have to enter it for them.
To enter data for someone else, first find the relevant observation (probably by navigating from the user_dashboard), and then click the Enter data for this observation link:
You will be presented with the questionnaire that the user would have seen.
Once complete, you’ll be redirected back to the Observation edit page.
Notice that a new Reply will be listed for that observation
You may need to set the originally_collected_on field of the Reply if the data was collected from the participant sometime before you are entering it into the system. See image below:
XXX TODO replace and update with additional view
SMS message replies¶
Because of limitations of the SMS system itself, where participants reply to an SMS it’s not possible to reliably reconnect their replies explicitly to a particular observation. For this reason, although SMS replies are stored in the database (using the signalbox.models.TextMessageCallback model), the content of SMS replies is not stored as an Answer.
Currently Signalbox makes an attempt to connect the inbound SMS messages with Observations in the following way:
- When an SMS is sent via twilio, an ObservationData object is stored which records the Twilio SmsSid value.
- When a reply is made within a limited period Twilio appears to return a response containing the original SmsSid value, which is again stored and used to link the two records (see the sms_replies() method of an Observation). However this behaviour is undocumented, and is probably not reliable.
When analysing SMS reply data, it’s probably better to rely on the sender phone number and match these with users’ numbers (e.g. using merge commands in Stata or SPSS).
..warning:: TL;DR: If users reply to SMS messages you will have to do extra work to export this data; it won’t automatically appear in the main datafile.