compileprofile-spacetests 0.3.0 → 0.4.0

package/src/__tests__/test-utils/testData.ts

@@ -1,80 +1,80 @@
-import * as fs from 'fs';
-import * as path from 'path';
-
-// Define interfaces for our test data types
-export interface TestDataFiles {
-  spatialCognition: any[];
-  nback: any[];
-  participant: any[];
-  gonogo: any[];
-  emotions: any[];
-}
-
-// Function to load all test data
-export function loadTestData(type: string): TestDataFiles {
-  const dataDir = path.join(process.cwd(), 'example-data');
-  
-  if (type === 'spatialCognition') {
-    return {
-      spatialCognition: JSON.parse(fs.readFileSync(path.join(dataDir, 'spatial-cognition.json'), 'utf-8')),
-      nback: [],
-      participant: [],
-      gonogo: [],
-      emotions: []
-    };
-  }
-  if (type === 'nback') {
-    return {
-      spatialCognition: [],
-      nback: JSON.parse(fs.readFileSync(path.join(dataDir, 'nback.json'), 'utf-8')),
-      participant: [],
-      gonogo: [],
-      emotions: []
-    };
-  }
-  if (type === 'participant') {
-    return {
-      spatialCognition: [],
-      nback: [],
-      participant: JSON.parse(fs.readFileSync(path.join(dataDir, 'participant.json'), 'utf-8')),
-      gonogo: [],
-      emotions: []
-    };
-  }
-  if (type === 'gonogo') {
-      return {
-      spatialCognition: [],
-      nback: [],
-      participant: [],
-      gonogo: JSON.parse(fs.readFileSync(path.join(dataDir, 'gonogo.json'), 'utf-8')),
-      emotions: []
-    };
-  }
-  if (type === 'emotions') {
-    return {
-      spatialCognition: [],
-      nback: [],
-      participant: [],
-      gonogo: [],
-      emotions: JSON.parse(fs.readFileSync(path.join(dataDir, 'emotions.json'), 'utf-8'))
-    };
-  }
-  if (type === 'all') {
-    return {
-      spatialCognition: JSON.parse(fs.readFileSync(path.join(dataDir, 'spatial-cognition.json'), 'utf-8')),
-      nback: JSON.parse(fs.readFileSync(path.join(dataDir, 'nback.json'), 'utf-8')),
-      participant: JSON.parse(fs.readFileSync(path.join(dataDir, 'participant.json'), 'utf-8')),
-      gonogo: JSON.parse(fs.readFileSync(path.join(dataDir, 'gonogo.json'), 'utf-8')),
-      emotions: JSON.parse(fs.readFileSync(path.join(dataDir, 'emotions.json'), 'utf-8'))
-    };
-  }
-  
-  // Default return for unknown types
-  return {
-    spatialCognition: [],
-    nback: [],
-    participant: [],
-    gonogo: [],
-    emotions: []
-  };
+import * as fs from 'fs';
+import * as path from 'path';
+
+// Define interfaces for our test data types
+export interface TestDataFiles {
+  spatialCognition: any[];
+  nback: any[];
+  participant: any[];
+  gonogo: any[];
+  emotions: any[];
+}
+
+// Function to load all test data
+export function loadTestData(type: string): TestDataFiles {
+  const dataDir = path.join(process.cwd(), 'example-data');
+  
+  if (type === 'spatialCognition') {
+    return {
+      spatialCognition: JSON.parse(fs.readFileSync(path.join(dataDir, 'spatial-cognition.json'), 'utf-8')),
+      nback: [],
+      participant: [],
+      gonogo: [],
+      emotions: []
+    };
+  }
+  if (type === 'nback') {
+    return {
+      spatialCognition: [],
+      nback: JSON.parse(fs.readFileSync(path.join(dataDir, 'nback.json'), 'utf-8')),
+      participant: [],
+      gonogo: [],
+      emotions: []
+    };
+  }
+  if (type === 'participant') {
+    return {
+      spatialCognition: [],
+      nback: [],
+      participant: JSON.parse(fs.readFileSync(path.join(dataDir, 'participant.json'), 'utf-8')),
+      gonogo: [],
+      emotions: []
+    };
+  }
+  if (type === 'gonogo') {
+      return {
+      spatialCognition: [],
+      nback: [],
+      participant: [],
+      gonogo: JSON.parse(fs.readFileSync(path.join(dataDir, 'gonogo.json'), 'utf-8')),
+      emotions: []
+    };
+  }
+  if (type === 'emotions') {
+    return {
+      spatialCognition: [],
+      nback: [],
+      participant: [],
+      gonogo: [],
+      emotions: JSON.parse(fs.readFileSync(path.join(dataDir, 'emotions.json'), 'utf-8'))
+    };
+  }
+  if (type === 'all') {
+    return {
+      spatialCognition: JSON.parse(fs.readFileSync(path.join(dataDir, 'spatial-cognition.json'), 'utf-8')),
+      nback: JSON.parse(fs.readFileSync(path.join(dataDir, 'nback.json'), 'utf-8')),
+      participant: JSON.parse(fs.readFileSync(path.join(dataDir, 'participant.json'), 'utf-8')),
+      gonogo: JSON.parse(fs.readFileSync(path.join(dataDir, 'gonogo.json'), 'utf-8')),
+      emotions: JSON.parse(fs.readFileSync(path.join(dataDir, 'emotions.json'), 'utf-8'))
+    };
+  }
+  
+  // Default return for unknown types
+  return {
+    spatialCognition: [],
+    nback: [],
+    participant: [],
+    gonogo: [],
+    emotions: []
+  };
 } 

package/src/common-interfaces.ts

@@ -1,79 +1,125 @@
-interface CommonResults {
-  n_trials: number;
-  n_correct_trials: number;
-  n_incorrect_trials: number;
-  avg_rt_total: number;
-  avg_rt_correct: number;
-  avg_rt_incorrect: number;
-  performance_score: number;
-}
-
-interface NbackSpecialResults {
-  target_trials: {
-    n: number;
-    avg_rt: number;
-    avg_acc: number;
-  };
-  non_target_trials: {
-    n: number;
-    avg_rt: number;
-    avg_acc: number;
-  };
-}
-
-interface SpatialSpecialResults {
-  by_distance: any[];
-  by_angle: any[];
-  by_rotation: any[];
-}
-
-interface GonogoSpecialResults {
-  by_block: any[];
-  go_trials: {
-    n: number;
-    avg_rt: number;
-    avg_acc: number;
-  };
-  nogo_trials: {
-    n: number;
-    avg_rt: number;
-    avg_acc: number;
-  };
-}
-
-interface EmotionSpecialResults {
-  by_emotion: any[];
-  confusion_matrix: any;
-}
-
-interface NbackResultsStructure {
-  common: CommonResults;
-  special: NbackSpecialResults;
-}
-
-interface SpatialResultsStructure {
-  common: CommonResults;
-  special: SpatialSpecialResults;
-}
-
-interface GonogoResultsStructure {
-  common: CommonResults;
-  special: GonogoSpecialResults;
-}
-
-interface EmotionResultsStructure {
-  common: CommonResults;
-  special: EmotionSpecialResults;
-}
-
-export {
-  CommonResults,
-  NbackResultsStructure,
-  SpatialResultsStructure,
-  GonogoResultsStructure,
-  EmotionResultsStructure,
-  NbackSpecialResults,
-  SpatialSpecialResults,
-  GonogoSpecialResults,
-  EmotionSpecialResults
+interface CommonResults {
+  n_trials: number;
+  n_correct_trials: number;
+  n_incorrect_trials: number;
+  avg_rt_total: number;
+  avg_rt_correct: number;
+  avg_rt_incorrect: number;
+  performance_score: number;
+}
+
+// Accuracy, signal detection and reaction times for one group of n-back trials
+interface NbackGroupResults {
+  n_trials: number;
+  n_correct_trials: number;
+  performance_score: number;
+  n_targets: number;
+  n_non_targets: number;
+  hits: number;
+  misses: number;
+  false_alarms: number;
+  correct_rejections: number;
+  hit_rate: number | null;
+  false_alarm_rate: number | null;
+  d_prime: number | null;
+  // Lures: non-targets repeating an image from a distance other than N. Their false alarms are
+  // also counted in false_alarms; a high lure_false_alarm_rate means responding to familiarity.
+  n_lures: number;
+  lure_false_alarms: number;
+  lure_false_alarm_rate: number | null;
+  avg_rt_hits: number | null;
+  avg_rt_false_alarms: number | null;
+}
+
+interface NbackBlockResults extends NbackGroupResults {
+  block: string;
+  block_index: number;
+  n_back: number;
+}
+
+interface NbackLevelResults extends NbackGroupResults {
+  n_back: number;
+}
+
+interface NbackSpecialResults {
+  target_trials: {
+    n: number;
+    avg_rt: number;
+    avg_acc: number;
+  };
+  non_target_trials: {
+    n: number;
+    avg_rt: number;
+    avg_acc: number;
+  };
+  // Only for test version 2+ data, whose trials carry n_back, block and block_index
+  by_block?: NbackBlockResults[];
+  by_nback?: NbackLevelResults[];
+}
+
+interface SpatialSpecialResults {
+  by_distance: any[];
+  by_angle: any[];
+  by_rotation: any[];
+}
+
+interface GonogoSpecialResults {
+  // Mean of go_trials.avg_acc (hit rate) and nogo_trials.avg_acc (correct-rejection rate).
+  // This is the accuracy the performance score uses, so withholding counts as much as responding.
+  balanced_acc: number;
+  // Per block: avg_rt over hits only, avg_acc = proportion correct, plus hit_rate,
+  // correct_rejection_rate and balanced_acc.
+  by_block: any[];
+  go_trials: {
+    n: number;
+    avg_rt: number;       // mean RT of hits (go trials with a response); 0 when there are none
+    avg_acc: number;      // hit rate
+    n_omissions: number;  // go trials without a response
+  };
+  nogo_trials: {
+    n: number;
+    avg_rt: number;       // mean RT of false alarms (no-go trials with a response); 0 when there are none
+    avg_acc: number;      // correct-rejection rate
+    n_commissions: number; // no-go trials with a response (false alarms)
+  };
+}
+
+interface EmotionSpecialResults {
+  by_emotion: any[];
+  confusion_matrix: any;
+}
+
+interface NbackResultsStructure {
+  common: CommonResults;
+  special: NbackSpecialResults;
+}
+
+interface SpatialResultsStructure {
+  common: CommonResults;
+  special: SpatialSpecialResults;
+}
+
+interface GonogoResultsStructure {
+  common: CommonResults;
+  special: GonogoSpecialResults;
+}
+
+interface EmotionResultsStructure {
+  common: CommonResults;
+  special: EmotionSpecialResults;
+}
+
+export {
+  CommonResults,
+  NbackResultsStructure,
+  SpatialResultsStructure,
+  GonogoResultsStructure,
+  EmotionResultsStructure,
+  NbackSpecialResults,
+  NbackGroupResults,
+  NbackBlockResults,
+  NbackLevelResults,
+  SpatialSpecialResults,
+  GonogoSpecialResults,
+  EmotionSpecialResults
 };

package/src/emotions.ts

@@ -1,98 +1,98 @@
-import { EmotionResultsStructure, CommonResults, EmotionSpecialResults } from './common-interfaces';
-
-const EMOTION_MAP = ["neutral", "sad", "happy", "surprised", "angry"];
-
-const emotion_calculate_results = (obj: any[]): EmotionResultsStructure => {
-  const trials = emotion_extract_trials(obj);
-  if (trials.length === 0) {
-    throw new Error("No trials found");
-  }
-  return emotion_results(trials);
-};
-
-const emotion_extract_trials = (obj: any[]) => {
-  // filter trials where response and rt are defined and not null
-  let trials = obj.filter((o: any) => 'response' in o && 'rt' in o && 'emotion' in o);
-  trials = trials.filter((o: any) => o.response !== null && o.rt !== null);
-  trials.forEach((o: any) => {
-    const match = o.emotion.match(/\/([^/]+)_([0-9]+)\.png/);
-    if (match) {
-      o.stimulus = match[0];
-      o.emotion = match[1];
-      o.image_number = match[2];
-      //this is <emotion>_<number>.png
-      o.image = `${match[1]}_${match[2]}.png`;
-    }
-  })
-  trials.forEach((o: any) => {
-    o.emotion_response = EMOTION_MAP[o.response] || "unknown";
-    o.correct = o.emotion === o.emotion_response;
-    // in the older ones there were 15 trials per rotation
-  });
-  return trials;  
-}
-
-const emotion_results = (obj: any[]): EmotionResultsStructure => {
-  if (obj.length === 0) {
-    throw new Error("No trials found");
-  }
-
-  const correct_trials = obj.filter((o: any) => o.correct === true);
-  const incorrect_trials = obj.filter((o: any) => o.correct === false);
-
-  const total_rt = obj.reduce((a, b) => a + (b.rt || 0), 0);
-  const correct_rt = correct_trials.reduce((a, b) => a + (b.rt || 0), 0);
-  const incorrect_rt = incorrect_trials.reduce((a, b) => a + (b.rt || 0), 0);
-
-  const avg_rt = total_rt / obj.length;
-  const avg_acc = correct_trials.length / obj.length;
-
-  // Calculate performance score using the existing formula
-  const best_score = 1000;
-  const worst_score = 10000;
-  let performance = avg_rt / (Math.pow(avg_acc, 5) + 0.001);
-  performance = Math.min(Math.max(performance, best_score), worst_score);
-  const performance_score = (1 - ((performance - best_score) / (worst_score - best_score))) * 100;
-
-  const common: CommonResults = {
-    n_trials: obj.length,
-    n_correct_trials: correct_trials.length,
-    n_incorrect_trials: incorrect_trials.length,
-    avg_rt_total: avg_rt,
-    avg_rt_correct: correct_trials.length > 0 ? correct_rt / correct_trials.length : 0,
-    avg_rt_incorrect: incorrect_trials.length > 0 ? incorrect_rt / incorrect_trials.length : 0,
-    performance_score
-  };
-
-  // Group by emotion for special results
-  const by_emotion = EMOTION_MAP.map(emotion => {
-    const emotion_trials = obj.filter((o: any) => o.emotion === emotion);
-    return {
-      emotion,
-      n: emotion_trials.length,
-      avg_rt: emotion_trials.length > 0 ? emotion_trials.reduce((a, b) => a + (b.rt || 0), 0) / emotion_trials.length : 0,
-      avg_acc: emotion_trials.length > 0 ? emotion_trials.reduce((a, b) => a + (b.correct ? 1 : 0), 0) / emotion_trials.length : 0,
-    };
-  });
-
-  // Create confusion matrix
-  const confusion_matrix = EMOTION_MAP.reduce((matrix: any, actual: string) => {
-    matrix[actual] = EMOTION_MAP.reduce((row: any, predicted: string) => {
-      row[predicted] = obj.filter((o: any) => o.emotion === actual && o.emotion_response === predicted).length;
-      return row;
-    }, {});
-    return matrix;
-  }, {});
-
-  const special: EmotionSpecialResults = {
-    by_emotion,
-    confusion_matrix
-  };
-
-  return {
-    common,
-    special
-  };
-}
-
-export {EmotionResultsStructure, emotion_calculate_results, emotion_extract_trials, emotion_results};
+import { EmotionResultsStructure, CommonResults, EmotionSpecialResults } from './common-interfaces';
+
+const EMOTION_MAP = ["neutral", "sad", "happy", "surprised", "angry"];
+
+const emotion_calculate_results = (obj: any[]): EmotionResultsStructure => {
+  const trials = emotion_extract_trials(obj);
+  if (trials.length === 0) {
+    throw new Error("No trials found");
+  }
+  return emotion_results(trials);
+};
+
+const emotion_extract_trials = (obj: any[]) => {
+  // filter trials where response and rt are defined and not null
+  let trials = obj.filter((o: any) => 'response' in o && 'rt' in o && 'emotion' in o);
+  trials = trials.filter((o: any) => o.response !== null && o.rt !== null);
+  trials.forEach((o: any) => {
+    const match = o.emotion.match(/\/([^/]+)_([0-9]+)\.png/);
+    if (match) {
+      o.stimulus = match[0];
+      o.emotion = match[1];
+      o.image_number = match[2];
+      //this is <emotion>_<number>.png
+      o.image = `${match[1]}_${match[2]}.png`;
+    }
+  })
+  trials.forEach((o: any) => {
+    o.emotion_response = EMOTION_MAP[o.response] || "unknown";
+    o.correct = o.emotion === o.emotion_response;
+    // in the older ones there were 15 trials per rotation
+  });
+  return trials;  
+}
+
+const emotion_results = (obj: any[]): EmotionResultsStructure => {
+  if (obj.length === 0) {
+    throw new Error("No trials found");
+  }
+
+  const correct_trials = obj.filter((o: any) => o.correct === true);
+  const incorrect_trials = obj.filter((o: any) => o.correct === false);
+
+  const total_rt = obj.reduce((a, b) => a + (b.rt || 0), 0);
+  const correct_rt = correct_trials.reduce((a, b) => a + (b.rt || 0), 0);
+  const incorrect_rt = incorrect_trials.reduce((a, b) => a + (b.rt || 0), 0);
+
+  const avg_rt = total_rt / obj.length;
+  const avg_acc = correct_trials.length / obj.length;
+
+  // Calculate performance score using the existing formula
+  const best_score = 1000;
+  const worst_score = 10000;
+  let performance = avg_rt / (Math.pow(avg_acc, 5) + 0.001);
+  performance = Math.min(Math.max(performance, best_score), worst_score);
+  const performance_score = (1 - ((performance - best_score) / (worst_score - best_score))) * 100;
+
+  const common: CommonResults = {
+    n_trials: obj.length,
+    n_correct_trials: correct_trials.length,
+    n_incorrect_trials: incorrect_trials.length,
+    avg_rt_total: avg_rt,
+    avg_rt_correct: correct_trials.length > 0 ? correct_rt / correct_trials.length : 0,
+    avg_rt_incorrect: incorrect_trials.length > 0 ? incorrect_rt / incorrect_trials.length : 0,
+    performance_score
+  };
+
+  // Group by emotion for special results
+  const by_emotion = EMOTION_MAP.map(emotion => {
+    const emotion_trials = obj.filter((o: any) => o.emotion === emotion);
+    return {
+      emotion,
+      n: emotion_trials.length,
+      avg_rt: emotion_trials.length > 0 ? emotion_trials.reduce((a, b) => a + (b.rt || 0), 0) / emotion_trials.length : 0,
+      avg_acc: emotion_trials.length > 0 ? emotion_trials.reduce((a, b) => a + (b.correct ? 1 : 0), 0) / emotion_trials.length : 0,
+    };
+  });
+
+  // Create confusion matrix
+  const confusion_matrix = EMOTION_MAP.reduce((matrix: any, actual: string) => {
+    matrix[actual] = EMOTION_MAP.reduce((row: any, predicted: string) => {
+      row[predicted] = obj.filter((o: any) => o.emotion === actual && o.emotion_response === predicted).length;
+      return row;
+    }, {});
+    return matrix;
+  }, {});
+
+  const special: EmotionSpecialResults = {
+    by_emotion,
+    confusion_matrix
+  };
+
+  return {
+    common,
+    special
+  };
+}
+
+export {EmotionResultsStructure, emotion_calculate_results, emotion_extract_trials, emotion_results};

package/src/getters.ts

@@ -1,21 +1,21 @@
-function getBrowserInformation(data: any[]): any {
-  const browserInfo = data.find(row => row.trial_type === "browser-check");
-  if (!browserInfo) {
-    return null;
-  }
-  return {
-    os: browserInfo.os,
-    mobile: browserInfo.mobile,
-    fullscreen: browserInfo.fullscreen,
-    vsync_rate: browserInfo.vsync_rate,
-    webcam: browserInfo.webcam,
-    microphone: browserInfo.microphone,
-    browser: browserInfo.browser,
-    browser_version: browserInfo.browser_version,
-    webaudio: browserInfo.webaudio,
-    width: browserInfo.width,
-    height: browserInfo.height
-  };
-}
-
-export { getBrowserInformation };
+function getBrowserInformation(data: any[]): any {
+  const browserInfo = data.find(row => row.trial_type === "browser-check");
+  if (!browserInfo) {
+    return null;
+  }
+  return {
+    os: browserInfo.os,
+    mobile: browserInfo.mobile,
+    fullscreen: browserInfo.fullscreen,
+    vsync_rate: browserInfo.vsync_rate,
+    webcam: browserInfo.webcam,
+    microphone: browserInfo.microphone,
+    browser: browserInfo.browser,
+    browser_version: browserInfo.browser_version,
+    webaudio: browserInfo.webaudio,
+    width: browserInfo.width,
+    height: browserInfo.height
+  };
+}
+
+export { getBrowserInformation };