Html Free Recall plugin #137

atakaragoz · 2024-09-04T16:25:27Z

Hello,

This plugin is compatible with jsPsych version 7+.

The plugin is supposed to approximate free recall experiments using typed responses as opposed to spoken ones. By removing the word as soon as the participant presses spacebar it removes the participant's ability to edit their previous responses as well as enables the participant to potentially provide repeats of words.

One could also use this plugin to perform free association experiments by having participants enter a single word at a time and not allow for edits.

The basic idea behind the plugin is to record the words a participant inputs and end the trial when a certain button (by default spacebar) is pressed. The best way to use this is within a loop as I've shown in the examples.

Please let me know if you think this plugin is superfluous or if you would prefer changes to documentation or features.

… think about how to do this more easily (or if I even need it)

Html text recall plugin

changeset-bot · 2024-09-04T16:25:30Z

⚠️ No Changeset found

Latest commit: 6c1114f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

jodeleeuw · 2024-09-28T13:51:11Z

Hi @atakaragoz

This is a great contribution. We're a little swamped right now so it might be another week or two before we can help with fixing the failing checks, but we're appreciative of the contribution and will get to it ASAP.

Adding package.json, appears to have been deleted at some point.

atakaragoz · 2024-11-20T12:54:58Z

Hello! I believe the issue was that the package.json was missing from my plugin directory. I've gone ahead and added that to see if it fixes things.

Please let me know if there is anything else I can do.

atakaragoz · 2025-02-11T17:24:01Z

Hello! Just wanted to see if there was any update on this?

m-delem · 2025-02-17T12:46:44Z

Hello @atakaragoz,

Thank you for the great plugin! I am currently testing it, this might be exactly what I needed to implement an online Deese-Roediger-McDermott paradigm.

There were a couple things I had to tweak here and there to have the examples running smoothly, so I thought I could share them. I have little to no experience of contributing to anyone else's code on GH, so let me know if I can do better than putting my snippets here.

First, this might be a difference between jsPsych 7 and 8, but the plugin type has to be specified differently in your examples:

var free_association_trial = {
  type: "html-written-recall"
}
// Returns an error. It should be:
var free_association_trial = {
  type: htmlWrittenRecall
}

In your examples, you use result data from your plugin called button_pressed as a condition in your loop_function():

var free_association_block = {
  timeline: [free_association_trial],
  loop_function() {
    if (jsPsych.data.get().last(1).values()[0].button_pressed) {
      return false;
    } else {
      return true;
    }
  }
}

However, in the latest version of your plugin you seem to have renamed this data button, so this condition is not working anymore. The working example becomes:

var free_association_block = {
  timeline: [free_association_trial],
  loop_function() {
    if (jsPsych.data.get().last(1).values()[0].button == "pressed") {
      return false;
    } else {
      return true;
    }
  }
}

Finally, warnings from jsPsych advised to add version and data fields to the info of your plugin. I added this to remove the warning on my end:

const info = {
    name: "html-written-recall",
    version: "1.0.0",
    // parameters: {...},
    data: {
      rt: {
        type: jspsych.ParameterType.INT,
      },
      stimulus: {
        type: jspsych.ParameterType.STRING,
      },
      response: {
        type: jspsych.ParameterType.STRING,
      },
      button: {
        type: jspsych.ParameterType.STRING,
      },
    },
}

Thanks again for the cool plugin!

jadeddelta · 2025-03-01T06:47:01Z

hey @atakaragoz, i can add this to my workload to get the plugin reviewed, just let me know if you are willing to work on suggestions or if i should make the modifications myself to make it ready to be published!

and thank you @m-delem for the comment! yes, the first one is a result of going from v6 to v7 actually! and good catch for adding the data fields, for v8, especially if we consider releasing this plugin as a v8 plugin rather than a v7 to be compatible with the most recent version of jspsych. as for contributing, since this is someone else's plugin, you'd normally just get permission to add commits onto their branch if they'd like. if you want a general overview on open source contribution, this guide does a fantastic job at giving you a basic idea!

atakaragoz · 2025-03-03T00:22:20Z

Hello @jadeddelta! Happy to make any changes that you wish for me to make just let me know what you'd like me to change and I will get right on it.

Also @m-delem, thank you for the improvements and glad it was at least helpful to you in some way. Best of luck in your DRM paradigm 😄!

jadeddelta

it looks good! i've added a good bit of details to look over for our first pass, and if you'd like to also update this plugin to v8 via adding the version and data fields, feel free to do so- but it's not necessary!

jadeddelta · 2025-03-04T20:07:38Z

packages/plugin-html-written-recall/examples/example1.html

+<html>
+	<head>
+		<script src="https://unpkg.com/[email protected]"></script>
+		<script src="../dist/index.browser.js"></script>


npm run build only builds an index.browser.min.js- but we recommend you change this to simply "../index.js" to use the raw file for development, just so that all error reporting works! (don't forget to do this for the other example file)

jadeddelta · 2025-03-04T20:08:43Z

packages/plugin-html-written-recall/examples/example1.html

+      }
+    });
+    var free_association_trial = {
+      type: 'html-written-recall',


don't forget to change this to htmlWrittenRecall for both examples!

jadeddelta · 2025-03-04T20:11:54Z

packages/plugin-html-written-recall/examples/example1.html

+      timeline: [free_association_trial],
+      loop_function() {
+        // Loop until 10 trials are completed
+        if (jsPsych.data.get().last(1).values()[0].button_pressed) {


remember to change this to jsPsych.data.get().last(1).values()[0].button == "pressed" for both examples

jadeddelta · 2025-03-04T20:16:33Z

packages/plugin-html-written-recall/index.js

+
+      if (trial.button_string !== null) {
+        new_html +=
+          '<div><button id="jspsych-html-keyboard-response-button" style="display: none; justify-content:center">' +


you can add the class to the button class="jspsych-btn" to keep the style consistent with other jspsych buttons

jadeddelta · 2025-03-04T20:36:43Z

packages/plugin-html-written-recall/examples/example1.html

+	</head>
+	<body></body>
+	<script>
+    // Example where a participant gives as many words as possible in time of 10 seconds


update comment to match what the trial does

jadeddelta · 2025-03-04T20:46:17Z

packages/plugin-html-written-recall/examples/example2.html

+    var free_recall_block = {
+      timeline: [free_recall_trial],
+      on_start: function() {
+        begin_block_time = performance.now();


begin_block_time doesn't exist within the scope for the block_time_start: begin_block_time in the previous trial, it would be best to define begin_block_time beforehand as performance.now() and then use that reference for both the free_recall_trial and the on_start function

jadeddelta · 2025-03-04T20:48:48Z

packages/plugin-html-written-recall/index.js

+        var trial_data = {
+          rt: response.rt,
+          stimulus: trial.stimulus,
+          response: textbox.value, // Get the value of the textbox


i get a weird condition on my testing where it'll keep the space bar in the next trial, maybe it would be good to clear the value of the textbox afterwards? otherwise each response after will be like " dog" instead of "dog"

this becomes especially evident for me if next_word_key is anything but the space bar key

jadeddelta · 2025-03-04T20:50:22Z

packages/plugin-html-written-recall/index.js

+        default: null,
+      },
+      next_word_key: {
+        type: jspsych.ParameterType.STRING,


you could specify this to be jspsych.ParameterType.KEY

atakaragoz and others added 8 commits December 24, 2023 00:26

Initial commit of html-written-recall

5afea90

Adding initial scaffolding for example and docs

7ce35ef

Merge branch 'jspsych:main' into html-text-recall-plugin

45aeb58

adding examples to docs, thinking about improvement to plugin

bed5c68

initial way to get stimulus_only_first and prompt_only_first. Need to…

88d341e

… think about how to do this more easily (or if I even need it)

Merge branch 'jspsych:main' into html-text-recall-plugin

6bab474

Merge branch 'jspsych:main' into html-text-recall-plugin

9ec9a66

Merge pull request #1 from atakaragoz/html-text-recall-plugin

d30b1e6

Html text recall plugin

Create package.json

6c1114f

Adding package.json, appears to have been deleted at some point.

jadeddelta requested changes Mar 4, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Html Free Recall plugin #137

Html Free Recall plugin #137

atakaragoz commented Sep 4, 2024

changeset-bot bot commented Sep 4, 2024 •

edited

Loading

jodeleeuw commented Sep 28, 2024

atakaragoz commented Nov 20, 2024

atakaragoz commented Feb 11, 2025

m-delem commented Feb 17, 2025

jadeddelta commented Mar 1, 2025

atakaragoz commented Mar 3, 2025

jadeddelta left a comment

jadeddelta Mar 4, 2025

jadeddelta Mar 4, 2025

jadeddelta Mar 4, 2025

jadeddelta Mar 4, 2025

jadeddelta Mar 4, 2025

jadeddelta Mar 4, 2025

jadeddelta Mar 4, 2025

jadeddelta Mar 4, 2025

Html Free Recall plugin #137

Are you sure you want to change the base?

Html Free Recall plugin #137

Conversation

atakaragoz commented Sep 4, 2024

changeset-bot bot commented Sep 4, 2024 • edited Loading

⚠️ No Changeset found

jodeleeuw commented Sep 28, 2024

atakaragoz commented Nov 20, 2024

atakaragoz commented Feb 11, 2025

m-delem commented Feb 17, 2025

jadeddelta commented Mar 1, 2025

atakaragoz commented Mar 3, 2025

jadeddelta left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

changeset-bot bot commented Sep 4, 2024 •

edited

Loading