Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ templates:
templateContent: # here we implement a prompt that we will reuse below
type: prompt
name: ${topicName}_presurvey # templates can take fields that are substituted in the templateContent
file: projects/example/demo_annotated/topics/${topicName}_survey.md # fields use the syntax ${fieldName}
file: demo/annotated_demo/topics/${topicName}_survey.md # fields use the syntax ${fieldName}

- templateName: crossPartisanDiscussion
contentType: treatment # it is quite common for a template to include the whole treatment structure, so that small changes can be made between conditions
Expand Down Expand Up @@ -44,9 +44,9 @@ templates:
duration: 45 # each stage has a specified duration in seconds
elements: # the elements displayed during each stage are listed from top to bottom.
- type: prompt # one type of element is a prompt, which displays text from a markdown file, and sometimes response options
file: projects/example/demo_annotated/game/describeConditionalAssignment.md # files are relative to the root path of the repository (for now), and can be organized however you like. In practice, it is helpful to organize by where the file is first used, e.g. intro, game, exit, and then separate folders for any stimuli that are used in multiple sections.
file: demo/annotated_demo/game/describeConditionalAssignment.md # files are relative to the root path of the repository (for now), and can be organized however you like. In practice, it is helpful to organize by where the file is first used, e.g. intro, game, exit, and then separate folders for any stimuli that are used in multiple sections.
- type: prompt
file: projects/example/demo_annotated/game/describeVideos.md
file: demo/annotated_demo/game/describeVideos.md
- type: timer # a timer is a progress bar counting down. It can start, end, and "warn" at the times you specify
endTime: 10
- type: submitButton # a submit button allows participants to proceed when they are (all) ready, rather than waiting for the timer
Expand All @@ -57,12 +57,12 @@ templates:
duration: 45
elements:
- type: prompt
file: projects/example/demo_annotated/game/describeTiming.md
file: demo/annotated_demo/game/describeTiming.md
- type: prompt
file: projects/example/demo_annotated/game/pre_discussion_instructions_democrat.md
file: demo/annotated_demo/game/pre_discussion_instructions_democrat.md
showToPositions: [0] # elements can be shown to all participants (default), or only those in listed positions
- type: prompt
file: projects/example/demo_annotated/game/pre_discussion_instructions_republican.md
file: demo/annotated_demo/game/pre_discussion_instructions_republican.md
showToPositions: [1]
- type: submitButton
buttonText: Begin Discussion
Expand All @@ -76,13 +76,13 @@ templates:
showTitle: true
elements:
- type: prompt
file: projects/example/demo_annotated/game/describeDiscussion.md
file: demo/annotated_demo/game/describeDiscussion.md
- type: prompt
file: projects/example/demo_annotated/game/discussion_instructions.md
file: demo/annotated_demo/game/discussion_instructions.md
- type: prompt
file: projects/example/demo_annotated/topics/${topicName}_discussion.md
file: demo/annotated_demo/topics/${topicName}_discussion.md
- type: prompt
file: projects/example/demo_annotated/game/discussion_wrapup.md
file: demo/annotated_demo/game/discussion_wrapup.md
displayTime: 15
- type: submitButton
name: endCall
Expand All @@ -93,9 +93,9 @@ templates:
- name: ManipulationCheck # Exit sequence items are asynchronous, and so do not have durations
elements:
- type: prompt
file: projects/example/demo_annotated/exit/describeReferences.md
file: demo/annotated_demo/exit/describeReferences.md
- type: prompt
file: projects/example/demo_annotated/exit/consider_partner.md
file: demo/annotated_demo/exit/consider_partner.md

- type: display # you can display variables from earlier in the experiment using a display element
reference: participantInfo.name # here we display the participant's partner's name
Expand All @@ -107,15 +107,15 @@ templates:
showToPositions: [1]

- type: prompt
file: projects/example/demo_annotated/exit/guess_partner_party.md
file: demo/annotated_demo/exit/guess_partner_party.md
name: guessPartnerParty # when prompts ask for input, you should give them a name so the results can be recorded
- type: prompt
file: projects/example/demo_annotated/exit/guess_partner_position.md
file: demo/annotated_demo/exit/guess_partner_position.md
- type: prompt
name: guessPartnerPosition
file: projects/example/demo_annotated/topics/${topicName}_survey.md
file: demo/annotated_demo/topics/${topicName}_survey.md
- type: prompt
file: projects/example/demo_annotated/intro/all_mandatory.md # my convention is to organize files according to where they are first used. This also helps indicate when files are reused across sections of the study, and is helpful when you want to ask the same question in pre/post.
file: demo/annotated_demo/intro/all_mandatory.md # my convention is to organize files according to where they are first used. This also helps indicate when files are reused across sections of the study, and is helpful when you want to ask the same question in pre/post.
- type: submitButton
conditions:
- reference: prompt.guessPartnerParty
Expand All @@ -126,12 +126,12 @@ templates:
- name: TraitRatingsPostTest # 8 questions
elements:
- type: prompt
file: projects/example/demo_annotated/exit/describeDisplayByPosition.md
file: demo/annotated_demo/exit/describeDisplayByPosition.md
- type: prompt
file: projects/example/demo_annotated/exit/consider_democrats.md
file: demo/annotated_demo/exit/consider_democrats.md
showToPositions: [1]
- type: prompt
file: projects/example/demo_annotated/exit/consider_republicans.md
file: demo/annotated_demo/exit/consider_republicans.md
showToPositions: [0]
- type: survey # we have a number of "canned" surveys available, which are implemented here: https://github.com/Watts-Lab/surveys
surveyName: TraitRatings # You include one just by specifying its name (this is different from the name below which is assigned to the response data)
Expand All @@ -144,25 +144,25 @@ introSequences: # introSequences are asynchronous sections that take place prior
- name: Sequence Description
elements:
- type: prompt
file: projects/example/demo_annotated/intro/describeAsyncSync.md
file: demo/annotated_demo/intro/describeAsyncSync.md
- type: submitButton
buttonText: Continue

- name: PoliticalLeaningsSurvey
elements:
- type: prompt
file: projects/example/demo_annotated/intro/describeSurvey.md
file: demo/annotated_demo/intro/describeSurvey.md
- type: survey
surveyName: PoliticalPartyUS
name: partyAffiliation # don't forget to name elements that collect responses, we use this name in references when assigning participants to groups

- name: TopicPreSurvey
elements:
- type: prompt
file: projects/example/demo_annotated/intro/describePrompts.md
file: demo/annotated_demo/intro/describePrompts.md

- type: prompt
file: projects/example/demo_annotated/intro/presurvey_instructions.md
file: demo/annotated_demo/intro/presurvey_instructions.md

- template: topicPrompt # references to templates can be used anywhere a full structure is allowed, and can be used multiple times
broadcast: # values can be filled in using broadcasting, which creates multiple instances of the template with different field values
Expand All @@ -171,7 +171,7 @@ introSequences: # introSequences are asynchronous sections that take place prior
- topicName: slaveReparations

- type: prompt
file: projects/example/demo_annotated/intro/all_mandatory.md
file: demo/annotated_demo/intro/all_mandatory.md

- type: submitButton
buttonText: Continue
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"batchName": "annotated_demo",
"cdn": "prod",
"treatmentFile": "projects/example/demo_annotated/demo.treatments.yaml",
"customIdInstructions": "projects/example/demo_annotated/intro/describeAnnotatedDemo.md",
"treatmentFile": "demo/annotated_demo/demo.treatments.yaml",
"customIdInstructions": "demo/annotated_demo/intro/describeAnnotatedDemo.md",
"platformConsent": "US",
"consentAddendum": "none",
"checkAudio": true,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"batchName": "annotated_demo",
"cdn": "local",
"treatmentFile": "projects/example/demo_annotated/demo.treatments.yaml",
"customIdInstructions": "projects/example/demo_annotated/intro/describeAnnotatedDemo.md",
"treatmentFile": "demo/annotated_demo/annotated_demo.treatments.yaml",
"customIdInstructions": "demo/annotated_demo/intro/describeAnnotatedDemo.md",
"platformConsent": "US",
"consentAddendum": "none",
"checkAudio": true,
Expand Down
10 changes: 10 additions & 0 deletions demo/annotated_demo/exit/consider_democrats.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: demo/annotated_demo/exit/consider_democrats.md
type: noResponse
---

![donkeyIcon](demo/annotated_demo/exit/donkey.jpg)

# Please share your feelings about **Democrats**:

---
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/exit/consider_partner.md
name: demo/annotated_demo/exit/consider_partner.md
type: noResponse
---

Expand Down
10 changes: 10 additions & 0 deletions demo/annotated_demo/exit/consider_republicans.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: demo/annotated_demo/exit/consider_republicans.md
type: noResponse
---

![elephantIcon](demo/annotated_demo/exit/elephant.jpg)

# Please share your feelings about **Republicans**:

---
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/exit/describeDisplayByPosition.md
name: demo/annotated_demo/exit/describeDisplayByPosition.md
type: noResponse
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/exit/describeReferences.md
name: demo/annotated_demo/exit/describeReferences.md
type: noResponse
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/exit/guess_partner_party.md
name: demo/annotated_demo/exit/guess_partner_party.md
type: multipleChoice
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/exit/guess_partner_position.md
name: demo/annotated_demo/exit/guess_partner_position.md
type: noResponse
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/game/describeConditionalAssignment.md
name: demo/annotated_demo/game/describeConditionalAssignment.md
type: noResponse
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/game/describeDiscussion.md
name: demo/annotated_demo/game/describeDiscussion.md
type: noResponse
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/game/describeTiming.md
name: demo/annotated_demo/game/describeTiming.md
type: noResponse
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/game/describeVideos.md
name: demo/annotated_demo/game/describeVideos.md
type: noResponse
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/game/discussion_instructions.md
name: demo/annotated_demo/game/discussion_instructions.md
type: noResponse
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/game/discussion_wrapup.md
name: demo/annotated_demo/game/discussion_wrapup.md
type: noResponse
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/game/pre_discussion_instructions_democrat.md
name: demo/annotated_demo/game/pre_discussion_instructions_democrat.md
type: noResponse
notes: To be shown to democrats paired with a republican
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/game/pre_discussion_instructions_republican.md
name: demo/annotated_demo/game/pre_discussion_instructions_republican.md
type: noResponse
notes: To be shown to republicans paired with a democrat
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/intro/all_mandatory.md
name: demo/annotated_demo/intro/all_mandatory.md
type: noResponse
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/intro/describeAsyncSync.md
name: demo/annotated_demo/intro/describeAsyncSync.md
type: noResponse
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/intro/describePrompts.md
name: demo/annotated_demo/intro/describePrompts.md
type: noResponse
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/intro/describeSurvey.md
name: demo/annotated_demo/intro/describeSurvey.md
type: noResponse
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/intro/presurvey_instructions.md
name: demo/annotated_demo/intro/presurvey_instructions.md
type: noResponse
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/topics/israelAid_discussion.md
name: demo/annotated_demo/topics/israelAid_discussion.md
title: israelAid
type: noResponse
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/topics/israelAid_survey.md
name: demo/annotated_demo/topics/israelAid_survey.md
title: israelAid
type: multipleChoice
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/topics/slaveReparations_discussion.md
name: demo/annotated_demo/topics/slaveReparations_discussion.md
title: slaveReparations
type: noResponse
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: projects/example/demo_annotated/topics/slaveReparations_survey.md
name: demo/annotated_demo/topics/slaveReparations_survey.md
title: slaveReparations
type: multipleChoice
---
Expand Down
1 change: 1 addition & 0 deletions demo/simple_demo/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This is a simple demo study that you can copy and use as a starting point for your own study designs.
26 changes: 26 additions & 0 deletions demo/simple_demo/dev.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"batchName": "annotated_demo",
"cdn": "local",
"treatmentFile": "demo/simple_demo/simple_demo.treatments.yaml",
"customIdInstructions": "none",
"platformConsent": "US",
"consentAddendum": "none",
"checkAudio": true,
"checkVideo": true,
"introSequence": "default",
"treatments": ["simple_demo"],
"payoffs": "equal",
"knockdowns": "none",
"dispatchWait": 1,
"launchDate": "immediate",
"centralPrereg": false,
"preregRepos": [],
"dataRepos": [],
"videoStorage": "none",
"exitCodes": {
"complete": "MyCompleteExitCode",
"error": "MyErrorExitCode",
"lobbyTimeout": "MyTimeoutExitCode",
"failedEquipmentCheck": "MyFailedEquipmentCheckExitCode"
}
}
11 changes: 11 additions & 0 deletions demo/simple_demo/exit/exit_question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: demo/simple_demo/exit/exit_question.md
type: multipleChoice
---

## Did you have a good conversation?

---

- yes
- no
8 changes: 8 additions & 0 deletions demo/simple_demo/game/discussion_prompt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: demo/simple_demo/game/discussion_prompt.md
type: noResponse
---

# Please introduce yourself to your partner

---
Loading