@lookit/record 5.0.0 → 6.0.0

package/README.md

@@ -140,11 +140,23 @@ whether babies love cats because of their soft fur or their twitchy tails.”
 
 #### Optional
 
-**`template` [String | "consent-template-5"]**
+**`template` [String option | "consent-template-5"]**
 
-Which consent document template to use. If you are setting up a new study, we
-recommend using the most recent (highest number) of these options. Options:
-`consent-template-5`, `consent-garden`.
+Which consent document template to use. Options: `consent-template-5`,
+`consent-garden`, `consent-recording-only`.
+
+Most studies should use `consent-template-5` (the default).
+
+If you are running a study that ONLY uses webcam recording for the consent
+statement (nothing else is recording during the session), then you should use
+the `consent-recording-only` template. This version removes/modifies some text
+that references additional webcam recordings during the session.
+
+By default, the `consent-recording-only` plugin assumes that, in addition to a
+consent trial, you are using CHS to collect other data/responses. If you are not
+collecting any other data on CHS (for instance, because the rest of the study
+takes place on a different platform), then you should change this using the
+`only_consent_on_chs` parameter (see below).
 
 **`additional_video_privacy_statement` [String | ""]**
 
@@ -220,6 +232,18 @@ Optional additional text for under header “Participation is voluntary”. E.g.
 “There are two sessions in this study; you will be invited to complete another
 session next month. It is okay not to do both sessions!”
 
+**`only_consent_on_chs` [Boolean | false]**
+
+This parameter is only relevant to the `consent-recording-only` template. If a
+different template is used, this parameter will be ignored.
+
+Whether or not the consent trial is the ONLY data being collected about the
+participant on CHS (e.g. the study redirects to an external URL after the
+consent trial). If `false` (the default), then the consent template will contain
+information about how CHS handles data/responses. If `true`, then the template
+will only reference the consent recording, and any statements about CHS access
+to data/responses are omitted.
+
 #### Additional customization available if REQUIRED by your IRB
 
 To accommodate a variety of idiosyncratic IRB requirements, various other fields
@@ -297,7 +321,9 @@ Replace the default spoken consent statement with your custom text.
 Whether to omit the phrase “or in the very unlikely event of a research-related
 injury” from the contact section. (This was required by the Northwestern IRB.)
 
-### Example
+### Examples
+
+**Standard use case**
 
 ```javascript
 const videoConsent = {
@@ -332,6 +358,51 @@ const videoConsent = {
 };
 ```
 
+**Study only uses webcam recording for consent**
+
+Use the `"consent-recording-only"` template when the study collects (some or
+all) data/responses on CHS, but webcam recording is only used for the consent
+statement (nothing else is recorded).
+
+```javascript
+const videoConsentRecOnly = {
+  type: chsRecord.VideoConsentPlugin,
+  template: "consent-recording-only",
+  PIName: "Jane Smith",
+  institution: "Science University",
+  PIContact: "Jane Smith at 123 456 7890",
+  purpose:
+    "Why do babies love cats? This study will help us find out whether babies love cats because of their soft fur or their twitchy tails.",
+  procedures:
+    "Your child will be shown pictures of lots of different cats, along with noises that cats make like meowing and purring. We are interested in which pictures and sounds make your child smile. We will ask you (the parent) to turn around to avoid influencing your child's responses.",
+  payment:
+    "After you finish the study, we will email you a $5 BabyStore gift card within approximately three days. To be eligible for the gift card your child must be in the age range for this study, you need to submit a valid consent statement, and we need to see that there is a child with you. But we will send a gift card even if you do not finish the whole study or we are not able to use your child's data! There are no other direct benefits to you or your child from participating, but we hope you will enjoy the experience.",
+};
+```
+
+**CHS study is only used for a consent recording**
+
+Use the `"consent-recording-only"` template with `only_consent_on_chs: true`
+when webcam recording is only used for the consent statement and no other
+data/responses are collected on CHS.
+
+```javascript
+const videoConsentRecOnly = {
+  type: chsRecord.VideoConsentPlugin,
+  template: "consent-recording-only",
+  only_consent_on_chs: true, // set this to true
+  PIName: "Jane Smith",
+  institution: "Science University",
+  PIContact: "Jane Smith at 123 456 7890",
+  purpose:
+    "Why do babies love cats? This study will help us find out whether babies love cats because of their soft fur or their twitchy tails.",
+  procedures:
+    "Your child will be shown pictures of lots of different cats, along with noises that cats make like meowing and purring. We are interested in which pictures and sounds make your child smile. We will ask you (the parent) to turn around to avoid influencing your child's responses.",
+  payment:
+    "After you finish the study, we will email you a $5 BabyStore gift card within approximately three days. To be eligible for the gift card your child must be in the age range for this study, you need to submit a valid consent statement, and we need to see that there is a child with you. But we will send a gift card even if you do not finish the whole study or we are not able to use your child's data! There are no other direct benefits to you or your child from participating, but we hope you will enjoy the experience.",
+};
+```
+
 ## Trial Recording Extension
 
 Trial recording can be added to most jsPsych trials. This is a jsPsych extension

package/dist/index.browser.js

@@ -32,7 +32,7 @@ var chsRecord = (function (Data, chsTemplates, jspsych) {
 
 	var _package = {
 	  name: "@lookit/record",
-	  version: "5.0.0",
+	  version: "6.0.0",
 	  description: "Recording extensions and plugins for CHS studies.",
 	  homepage: "https://github.com/lookit/lookit-jspsych#readme",
 	  bugs: {
@@ -74,7 +74,7 @@ var chsRecord = (function (Data, chsTemplates, jspsych) {
 	  },
 	  peerDependencies: {
 	    "@lookit/data": "^0.3.0",
-	    "@lookit/templates": "^3.0.0",
+	    "@lookit/templates": "^3.1.0",
 	    jspsych: "^8.0.3"
 	  }
 	};
@@ -8765,7 +8765,15 @@ var chsRecord = (function (Data, chsTemplates, jspsych) {
 	  name: "consent-video",
 	  version: _package.version,
 	  parameters: {
-	    template: { type: jspsych.ParameterType.STRING, default: "consent-template-5" },
+	    template: {
+	      type: jspsych.ParameterType.SELECT,
+	      options: [
+	        "consent-template-5",
+	        "consent-garden",
+	        "consent-recording-only"
+	      ],
+	      default: "consent-template-5"
+	    },
 	    locale: { type: jspsych.ParameterType.STRING, default: "en-us" },
 	    additional_video_privacy_statement: {
 	      type: jspsych.ParameterType.STRING,
@@ -8810,7 +8818,8 @@ var chsRecord = (function (Data, chsTemplates, jspsych) {
 	    prompt_all_adults: { type: jspsych.ParameterType.BOOL, default: false },
 	    prompt_only_adults: { type: jspsych.ParameterType.BOOL, default: false },
 	    consent_statement_text: { type: jspsych.ParameterType.STRING, default: "" },
-	    omit_injury_phrase: { type: jspsych.ParameterType.BOOL, default: false }
+	    omit_injury_phrase: { type: jspsych.ParameterType.BOOL, default: false },
+	    only_consent_on_chs: { type: jspsych.ParameterType.BOOL, default: false }
 	  },
 	  data: {
 	    chs_type: {
@@ -9543,4 +9552,4 @@ var chsRecord = (function (Data, chsTemplates, jspsych) {
 	return index;
 
 })(chsData, chsTemplates, jsPsychModule);
-//# sourceMappingURL=https://unpkg.com/@lookit/record@5.0.0/dist/index.browser.js.map
+//# sourceMappingURL=https://unpkg.com/@lookit/record@6.0.0/dist/index.browser.js.map