Skip to main content
Version: 3.3.x

Local Application

A major feature of Honeycomb is the ability to bundle JsPsych tasks into applications that can be run on any computer in a lab or clinic. Installers for these applications can be created for Windows, Mac, and Linux. The applications can be run without an internet connection, and do not require any additional software to be installed on the computer.

Installers for these applications can be created on demand and/or automatically when a new release is created. This is called "Continuous Deployment" - more information about Honeycomb's CI/CD workflow can be found here here.

Creating a Release​

Follow the GitHub documentation for creating a release.

The tag should be in the format vX.X.X where X.X.X is the version number of the release. For example, if the release is version 1.0.0, the tag should be v1.0.0.

warning

Your release must included a new tag for the CI/CD workflow to work.

Installing the task​

  1. Navigate to the repository's "Releases" tab and select the tag you created from above
  2. Download the correct installer for your operating system
  3. Double click the installer to run it. Follow the instructions to install the application.

Running the Task​

The task can be run by double-clicking the application icon on the desktop.

The local application will run the task in a full-screen window. This aims to prevent study participants from doing anything else on the computer while the task is running. However, the task can be exited if needed with the following shortcut:

⌘ + Q

Working with Data​

Data is automatically saved throughout the task and moved to a nested folder structure on the Desktop when the task is completed. Note how the folders are organized by studyID and participantID. Each session is saved as its own .json file; it's name is the timestamp of start_date of the task.

Early Exits​

The run-through of an experiment in which the tasks exits prematurely will NOT be sent to the desktop. However, what data was collected is available in the user's "userData" folder which can be found in the following location:

~/Library/Application Support/honeycomb/TempData
caution

The .json file will likely not be formatted correctly because of the early exit. Take extra care to fix the file before using it for data analysis.