Science Score: 52.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
    Organization brain-development-and-disorders-lab has institutional domain (sites.wustl.edu)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.2%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

Intentions Game

Basic Info
  • Host: GitHub
  • Owner: Brain-Development-and-Disorders-Lab
  • License: other
  • Language: JavaScript
  • Default Branch: main
  • Homepage:
  • Size: 49.1 MB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 5 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog License Citation

README.md

Intentions Game

Getting Started

Client

Before building or previewing the client, ensure that the Node.js version 14+ is installed on your system. Download Node.js here and install Yarn using this command npm i -g yarn.

After installing Yarn, run yarn in the top-level repository directory to install all dependencies. Refer to Development below for other commands to build and preview the client.

Experiment Manipulations

| Parameter | Type | Description | Notes | | --------------------------------- | ------- | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | partner | string | Sets the partner type for testing purposes | "test" is a shorter collection of trials, otherwise use "default" | | requireID | boolean | Controls whether participant ID is required | | | useButtonInput | boolean | Enables button-based input scheme | Includes additional instructions, enables selection indicators for all screens | | useOfflinePackages | boolean | Enables offline R package usage | Only use for local deployments | | enableEndingQuestionnaires | boolean | Controls post-experiment questionnaire display | Shows a DASS and social media usage questionnaire at the conclusion of the experiment | | useAdultQuestionnaires | boolean | Enables adult-specific questionnaire content | Requires enableEndingQuestionnaires to be true, uses the adult questions if true, else false to show the adolescent set | | enableStatusPhaseOne | boolean | Enables social status display in first phase | Includes additional instructions and social status questionnaire prior to experiment starting, shows status display above partner in Phase One | | enableStatusPhaseTwo | boolean | Enables social status display in second phase | Includes additional instructions and social status questionnaire prior to experiment starting, shows status display above partner in Phase Two | | enableStatusPhaseThree | boolean | Enables social status display in third phase | Includes additional instructions and social status questionnaire prior to experiment starting, shows status display above partner in Phase Three | | isPartnerHighStatusPhaseOne | boolean | Sets partner as high status in first phase | Requires enableStatusPhaseOne to be true | | isPartnerHighStatusPhaseTwo | boolean | Sets partner as high status in second phase | Requires isPartnerHighStatusPhaseTwo to be true | | isPartnerHighStatusPhaseThree | boolean | Sets partner as high status in third phase | Requires isPartnerHighStatusPhaseThree to be true | | enableCyberball | boolean | Enables Cyberball exclusion/inclusion task | Includes additional instructions and social status questionnaire prior to experiment starting | | cyberballIsInclusive | boolean | Controls whether Cyberball task is inclusive | Cyberball operates in inclusion mode when true, otherwise operating in exclusion mode, changes to probabilities can be made in configuration.ts | | cyberballIsPartnerHighStatus | boolean | Sets partner as high status in Cyberball task | Shows social status display above Partner A, partner has high status when true, otherwise low status when false |

Server

[!CAUTION] The server component of the Intentions Game has been deprecated, and partner computations are now performed by the client. The documentation below pertains to the archived server.zip file contents.

The server uses Python and R to generate partner behavior for a phase of the task. To run the server, the following packages are required:

Required R packages (including dependencies):

  • codetools
  • iterators
  • jsonlite
  • foreach
  • doParallel
  • cli
  • generics
  • glue
  • lifecycle
  • magrittr
  • pillar
  • R6
  • rlang
  • tibble
  • tidyselect
  • utf8
  • fansi
  • vctrs
  • pkgconfig
  • withr
  • dplyr
  • logger

Development

  • yarn clean: Remove all client build artefacts and logs.
  • yarn build: Create a production build of the client.
  • yarn lint: Run the client source code through ESLint to check for any style violations.
  • yarn start: Start a Webpack HMR-compatible development server to preview the client locally on localhost:8080.
  • yarn test: Run all client tests.

Offline Usage

The task includes a packages directory containing all required R packages. To use these packages, set the useOfflinePackages manipulation within Configuration.ts to true. Each package was built and prepared using the rwasm tool.

Use the yarn build command to build the client with the offline packages, build output is placed in the dist directory. To run the task, use the yarn start command or run an instance of http-server using the dist directory.

Additional Features

  • Alternate input scheme for usage with MRI controllers. Keys 1 and 2 used to move UI selection cursor, 3 used to interact with UI element. Experiment collects 5 key input timestamps (in Unix epoch format) and stores at the end of the data file.
  • Incrementally saving data to localStorage for each experiment. In the case of the game crashing or exiting the browser window, the next time the game is accessed, an alert will prompt the user that the previous experiment did not complete and allow them to download the data captured. This feature is disabled by default (for online testing scenarios using Gorilla). It is advisable to enable this feature when the faciliator is physically present to deliver the experiment.

License

Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Issues and Feedback

Please contact Henry Burgess <henry.burgess@wustl.edu> for all code-related issues and feedback.

Owner

  • Name: Brain Development and Disorders Lab
  • Login: Brain-Development-and-Disorders-Lab
  • Kind: organization
  • Email: corpuscallosumresearch@wustl.edu
  • Location: United States of America

Brain Development and Disorders Lab at Washington University School of Medicine, Department of Neuroscience, St. Louis MO

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this task, please cite it as below."
authors:
- family-names: "Burgess"
  given-names: "Henry"
  orcid: "https://orcid.org/0000-0002-3481-952X"
title: "Intentions Game"
version: 1.7.0
date-released: 2023-11-20
url: "https://github.com/Brain-Development-and-Disorders-Lab/task_intentions"

GitHub Events

Total
  • Release event: 5
  • Delete event: 19
  • Push event: 110
  • Pull request event: 37
  • Create event: 26
Last Year
  • Release event: 5
  • Delete event: 19
  • Push event: 110
  • Pull request event: 37
  • Create event: 26

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 0
  • Total pull requests: 19
  • Average time to close issues: N/A
  • Average time to close pull requests: 13 minutes
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 19
  • Average time to close issues: N/A
  • Average time to close pull requests: 13 minutes
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • henryjburg (21)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/main.yml actions
  • actions/checkout v2 composite
  • actions/setup-node v1 composite
client/package.json npm
  • @babel/core ^7.14.6 development
  • @babel/plugin-proposal-class-properties ^7.14.5 development
  • @babel/plugin-syntax-dynamic-import ^7.8.3 development
  • @babel/preset-env ^7.14.7 development
  • @babel/preset-react ^7.14.5 development
  • @babel/preset-typescript ^7.14.5 development
  • @testing-library/jest-dom ^5.16.1 development
  • @testing-library/react ^12.1.2 development
  • @types/crypto-js ^4.1.1 development
  • @types/d3 ^7.1.0 development
  • @types/jest ^27.4.1 development
  • @types/jest-axe ^3.5.3 development
  • @types/node ^17.0.9 development
  • @types/react ^17.0.37 development
  • @types/react-dom ^17.0.11 development
  • @typescript-eslint/eslint-plugin ^4.28.1 development
  • @typescript-eslint/parser ^4.28.1 development
  • babel-loader ^8.2.2 development
  • consola ^2.15.3 development
  • css-loader ^5.2.6 development
  • csv-loader ^3.0.3 development
  • del ^6.0.0 development
  • eslint ^7.22.0 development
  • eslint-config-google ^0.14.0 development
  • eslint-config-prettier ^8.5.0 development
  • eslint-plugin-react-hooks ^4.3.0 development
  • gulp ^4.0.2 development
  • gulp-eslint ^6.0.0 development
  • html-loader ^3.1.0 development
  • html-webpack-plugin ^5.3.2 development
  • javascript-obfuscator ^4.0.0 development
  • jest ^27.4.7 development
  • jest-axe ^5.0.1 development
  • jest-canvas-mock ^2.4.0 development
  • prettier 2.6.1 development
  • react ^18.1.0 development
  • react-dom ^18.1.0 development
  • react-use ^17.4.0 development
  • regenerator-runtime ^0.13.9 development
  • sass ^1.49.8 development
  • sass-loader ^12.6.0 development
  • style-loader ^3.0.0 development
  • styled-components ^5.3.3 development
  • ts-jest ^27.1.3 development
  • ts-loader ^9.2.3 development
  • typescript ^4.5.4 development
  • usehooks-ts ^2.5.4 development
  • webpack ^5.69.1 development
  • webpack-cli ^4.7.2 development
  • webpack-dev-server ^3.11.2 development
  • webpack-obfuscator ^3.5.1 development
  • axios ^0.25.0
  • boring-neutral-avatars ^1.6.4
  • core-js ^3.21.1
  • d3 ^7.3.0
  • d3-array ^3.1.1
  • d3-random ^3.0.1
  • grommet ^2.17.3
  • grommet-icons ^4.6.0
  • jspsych ^6.3.0
  • jspsych-attention-check ^2.1.1
  • neurocog ^0.3.8
  • react-confetti ^6.1.0
  • react-text-transition ^1.3.0
  • regenerator-runtime ^0.13.9
client/yarn.lock npm
  • 1352 dependencies
server/requirements.txt pypi
  • flask *
  • flask_cors *
  • pandas *
  • rpy2 ==3.5.1
server/tests/requirements.txt pypi
  • pytest * test
  • requests * test