@bdelab/roav-ran 1.0.33 → 1.1.1

package/LICENSE

@@ -0,0 +1,27 @@
+STANFORD ACADEMIC SOFTWARE LICENSE FOR ROAR™
+Stanford Docket S21-342: "Rapid Online Assessment of Reading "ROAR™")"
+
+Please address any communications to: jyeatman@stanford.edu and otl@stanford.edu 
+
+By accessing the software in this folder, you are agreeing to the license terms listed below.
+
+1. THE BOARD OF TRUSTEES OF THE LELAND STANFORD JUNIOR UNIVERSITY (“Stanford”) has an assignment to "Rapid Online Assessment of Reading ("ROAR™")" ("Software"), described in Stanford Docket S21-342, which was developed by Professor Jason Yeatman in the Graduate School of Education. 
+2. By accessing, downloading, accepting, receiving, or using Software, including any accompanying information, materials or manuals you ("RECIPIENT") are agreeing to be bound by the terms of this License.  If you do not agree to the terms of this License, do not download, use or view any files from this directory.
+3. STANFORD grants to RECIPIENT a limited royalty-free, nonexclusive, and nontransferable license to use the Software furnished hereunder, upon the terms and conditions set out below. 
+4. RECIPIENT acknowledges that the Software is a research tool still in the development stage and that it is being supplied as is, without any accompanying services, support or improvements from STANFORD.  STANFORD makes no representations and extends no warranties of any kind, either express or implied other than set out in this License.
+5. RECIPIENT agrees to use the Software solely for internal academic, non-commercial purposes and shall not distribute or transfer the Software or any modifications, enhancements, adaptations, re-implementations, based on, or implementing the functionality of (“Derivatives”) from RECIPIENT to another location or to any other person without prior written permission from STANFORD. RECIPIENT may not further distribute this Software or any Derivatives thereof. 
+6. RECIPIENT agrees not to reverse engineer, reverse assemble, reverse compile, decompile, disassemble, or otherwise attempt to re-create the source code for the Software. RECIPIENT acknowledges that any programs created based on or with the same functionality as the Software will be considered a Derivative as defined in 5 above, of Software and owned by STANFORD. 
+7. RECIPIENT may make modifications to the Software and integrate Software into RECIPIENT's own software for its own internal non-commercial use academic research use. All Derivative works are owned by Jason Yeatman and Stanford.
+8. RECIPIENT may not further distribute Software or its Derivatives without express written permission of STANFORD. If permission to transfer the Software or a Derivative is given, RECIPIENT warrants and agrees that:
+  RECIPIENT will not remove or export any part of the Software from the United States except in full compliance with all United States export regulations and all  applicable laws;
+  Will include a copy of this License which all RECIPIENTS must agree to.
+9. RECIPIENT will use the Software in compliance with all applicable laws, policies and regulations including, but not limited to, any approvals, informed consent and patient confidentiality principles.
+10. RECIPIENT will indemnify, hold harmless, and defend STANFORD against any claim of any kind arising out of or related to the exercise of any rights granted under this License or the breach of this License by RECIPIENT.
+11. Title and copyright to the Software, any Derivatives,  associated documentation, and content shall at all times remain with the Yeatman Lab at  STANFORD, and RECIPIENT agrees to preserve the same.
+12. If RECIPIENT plans to publish any peer reviewed papers, abstracts, or similar publications, RECIPIENT agrees to acknowledge Software and its creator, Professor Jason Yeatman, in a manner consistent with academic (industry) practice in addition to the marking requirements outlined above. 
+13. If RECIPIENT decides to terminate this License, RECIPIENT shall destroy or return immediately all Software and all Derivative works.
+14. RECIPIENT must display in any web-based application, interface, or hosted Derivative work using the Software a prominent attribution on its main dashboard or landing page. The attribution must read: “Powered by ROAR” and include a link to https://roar.stanford.edu (or equivalent site specified by Stanford). The attribution must be legible, visible during normal use, and placed in a standard UI location such as a header, footer, or corner banner.
+15. RECIPIENT must acknowledge ROAR in a README file in the repository of any Derivative work. The README should include the lines: “This software is based on the Rapid Online Assessment of Reading (ROAR) and/or the Rapid Online Assessment Dashboard (ROAD), developed by the Yeatman Lab at Stanford University.” The README should also include a link to the upstream software on which the derivative is based.
+16. RECIPIENT must cite the following paper in any academic publications for which the Software was used:
+Yeatman, J. D., Tang, K. A., Donnelly, P. M., Yablonski, M., Ramamurthy, M., Karipidis, I. I., Caffarra, S., Takada, M. E., Kanopka, K., Ben-Shachar, M., & Domingue, B. W. (2021). Rapid online assessment of reading ability. Scientific Reports, 11(1), 6396.
+

package/README.md

@@ -1,7 +1,84 @@
-# ROAV-RAN
+# Roav RAN
 
-This is a first draft of the RAN assessment
+## Overview
 
-## How to run
+Roav RAN is a modular JavaScript-based framework for running RAN . The application begins at `src/experiment/index.js`, which manages and calls the various views that control different aspects of the test.
 
-Head to command console, change directory to RAN folder, and enter "npm run dev" or "npm run prod"
+## Structure
+
+Each view is a separate JavaScript file located in the `views` folder. These views handle different parts of the experiment, from consent collection to calibration and the main crowding test. Below is a breakdown of each view and its purpose.
+
+### Views Breakdown
+
+#### Consent View
+
+- **File:** `views/consentView.js`
+- **Description:** Displays the consent form. Participants must accept before proceeding to the next step.
+
+#### Configure Device View
+
+- **File:** `views/configureDeviceView.js`
+- **Description:** Requests camera (and/or microphone) access, ensures proper seating position, and allows configuration of device details such as screen size.
+
+#### Calibration View
+
+- **File:** `views/calibrationView.js`
+- **Description:** Displays a blue stimulus for eye tracking calibration. A simple linear regressor estimates gaze position based on the response.
+
+#### Menu View
+
+- **File:** `views/menuView.js`
+- **Description:** Displays available tasks, dynamically loading them from the storage bucket. For example, crowding tests may have different versions (e.g., letters vs. symbols).
+
+#### Crowding View
+
+- **File:** `views/RANView.js`
+- **Description:** The core RAN test, where participants perform the task.
+
+#### Story View
+
+- **File:** `views/storyView.js`
+- **Description:** Presents a story as part of the experiment.
+
+#### Preload View
+
+- **File:** `views/preloadView.js`
+- **Description:** A blank screen that preloads files into cache to optimize performance.
+
+## View Structure
+
+Each view follows a consistent structure to maintain modularity and ease of testing. For example, `configureDeviceView` consists of three main components:
+
+1. **HTML File:** Defines the layout and styling of the view.
+2. **JavaScript File:** Contains the logic for user interaction and view functionality.
+3. **View Loader (views.js):** Loads the corresponding HTML and JavaScript files, initializes a wrapper `div`, and injects it into the document body.
+
+### View Lifecycle
+
+- A view starts by creating a container `div`.
+- It loads the necessary HTML and JavaScript files.
+- The `div` is added to `document.body`.
+- The view ends when a resolve flag is triggered (e.g., a button click or programmatic completion of a task).
+
+## Design Philosophy
+
+The structure was designed to be highly modular, allowing for easy swapping and modification of different views during the testing phase. While some aspects could be streamlined further, refactoring will only take place once the test design is finalized and stable.
+
+## Eye Tracking
+
+There are a few pertinent files related to handling eye tracking, which exist across the three web apps. These include `videoCapture.js`, `headeyetracking.js`, and `eyetrackingVars.html`.
+
+### Video Capture
+
+- **File:** `videoCapture.js`
+- **Description:** Contains functions to start and stop the camera. This is essential as it is the first step in running the eye tracking model, which ingests webcam feeds.
+
+### Head and Eye Tracking
+
+- **File:** `headeyetracking.js`
+- **Description:** Processes the webcam feed and passes it into the eye tracking model to predict x, y coordinates of gaze.
+
+### Eye Tracking Variables
+
+- **File:** `eyetrackingVars.html`
+- **Description:** Initializes global variables needed to run the eye tracking model, such as `leftEyeCoordinates` and `rightEyeCoordinates`, which store the model's predictions. It also initializes FaceMesh (a Google product) to track the face and crop the eyes before passing them into the eye tracking model.

package/lib/_sentry-release-injection-file.0975f6c0.js

@@ -0,0 +1,2 @@
+;!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="f805dfa3-8301-4ee4-afbb-66291177a5f6",e._sentryDebugIdIdentifier="sentry-dbid-f805dfa3-8301-4ee4-afbb-66291177a5f6")}catch(e){}}();("undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{}).SENTRY_RELEASE={id:"cd9832ac60c8c967b5081190cc904c023f77a0c6"};
+//# sourceMappingURL=_sentry-release-injection-file.0975f6c0.js.map

package/lib/_sentry-release-injection-file.0975f6c0.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_sentry-release-injection-file.0975f6c0.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}