Checkbox for ad-hoc results adding & tests

Author: Jack Brookes

Assets/UXF/Scripts/Etc/Trial.cs

@@ -51,7 +51,7 @@ public class Trial
         /// <summary>
         /// Dictionary of results in a order.
         /// </summary>
-        public OrderedResultDict result;
+        public ResultsDictionary result;
 
         /// <summary>
         /// Manually create a trial. When doing this you need to add this trial to a block with block.trials.Add(trial)
@@ -82,9 +82,7 @@ public void Begin()
 
             status = TrialStatus.InProgress;
             startTime = Time.time;
-            result = new OrderedResultDict();
-            foreach (string h in session.Headers)
-                result.Add(h, string.Empty);
+            result = new ResultsDictionary(session.Headers, session.adHocHeaderAdd);
 
             result["directory"] = Extensions.CombinePaths(session.experimentName, session.ppid, session.FolderName).Replace('\\', '/');
             result["experiment"] = session.experimentName;

Assets/UXF/Scripts/FileIOManager.cs

@@ -205,23 +205,34 @@ public void WriteJson(object serializableObject, WriteFileInfo writeFileInfo)
         /// <summary>
         /// Writes trial data (List of OrderedResultsDict) to file at fpath
         /// </summary>
-        /// <param name="dataDict"></param>
-        /// <param name="headers"></param>
+        /// <param name="dictList"></param>
         /// <param name="fpath"></param>
-        public void WriteTrials(List<OrderedResultDict> dataDict, string[] headers, WriteFileInfo writeFileInfo)
+        public void WriteTrials(List<ResultsDictionary> dictList, WriteFileInfo writeFileInfo)
         {
-            string[] csvRows = new string[dataDict.Count + 1];
-            csvRows[0] = string.Join(",", headers.ToArray());
-            object[] row = new object[headers.Length];
+            // generate list of all headers possible
+            // hashset keeps unique set of keys
+            HashSet<string> headers = new HashSet<string>();
+            foreach (ResultsDictionary dict in dictList)
+                foreach (string key in dict.Keys)
+                    headers.Add(key);
+
+            // final output: array of rows (comma-separated strings)
+            string[] csvRows = new string[dictList.Count + 1];
 
-            for (int i = 1; i <= dataDict.Count; i++)
+            // first row: headers
+            csvRows[0] = string.Join(",", headers.ToArray());
+            
+            for (int i = 0; i < dictList.Count; i++)
             {
-                OrderedResultDict dict = dataDict[i - 1];
-                if (dict != null)
-                {
-                    dict.Values.CopyTo(row, 0);
-                    csvRows[i] = string.Join(",", row.Select(v => System.Convert.ToString(v)).ToArray());
-                }
+                ResultsDictionary dict = dictList[i];
+
+                // add all observations to the row, in correct order.
+                // check if null, if so assign to empty string (?? operator)
+                var row = headers
+                    .Select(header => (dict[header] ?? string.Empty).ToString());
+
+                // join to string & store in output
+                csvRows[i + 1] = string.Join(",", row.ToArray());               
             }
 
             File.WriteAllLines(writeFileInfo.FullPath, csvRows);

Assets/UXF/Scripts/Session.cs

@@ -36,6 +36,13 @@ public class Session : MonoBehaviour
         /// </summary>
         [Tooltip("Enable to automatically end the session when the final trial has ended.")]
         public bool endAfterLastTrial = false;
+        
+        /// <summary>
+        /// If enabled, results that are not listed in Custom Headers can be added at any time. If disabled, adding results that are not listed in Custom Headers will throw an error.
+        /// </summary>
+        [Tooltip("If enabled, results that are not listed in Custom Headers can be added at any time. If disabled, adding results that are not listed in Custom Headers will throw an error.")]
+        public bool adHocHeaderAdd = false;
+
 
         /// <summary>
         /// List of blocks for this experiment
@@ -719,9 +726,8 @@ public void End()
 
         void SaveResults()
         {
-            List<OrderedResultDict> results = Trials.Select(t => t.result).ToList();
+            List<ResultsDictionary> results = Trials.Select(t => t.result).ToList();
             string fileName = "trial_results.csv";
-
             WriteFileInfo fileInfo = new WriteFileInfo(
                 WriteFileType.Trials,
                 BasePath,
@@ -731,7 +737,7 @@ void SaveResults()
                 fileName
                 );
 
-            fileIOManager.ManageInWorker(() => fileIOManager.WriteTrials(results, Headers.ToArray(), fileInfo));
+            fileIOManager.ManageInWorker(() => fileIOManager.WriteTrials(results, fileInfo));
         }
 
 

Assets/UXF/Scripts/Tests/Editor/TestTrials.cs

@@ -18,8 +18,7 @@ public class TestTrials
         FileIOManager fileIOManager;
         SessionLogger sessionLogger;
 
-        [SetUp]
-        public void SetUp()
+        void Start(bool adHoc)
         {
             gameObject = new GameObject();
             fileIOManager = gameObject.AddComponent<FileIOManager>();
@@ -30,6 +29,8 @@ public void SetUp()
                 fileIOManager
             );
 
+            session.adHocHeaderAdd = adHoc;
+
             sessionLogger.AttachReferences(
                 fileIOManager,
                 session
@@ -41,7 +42,7 @@ public void SetUp()
             fileIOManager.Begin();
 
             string experimentName = "unit_test";
-            string ppid = "test_trials";
+            string ppid = "test_trials" + (adHoc ? "_adhoc" : "");
             session.Begin(experimentName, ppid, "example_output");
             session.customHeaders.Add("observation");
             session.customHeaders.Add("null_observation");
@@ -51,8 +52,7 @@ public void SetUp()
             session.CreateBlock(3);
         }
 
-        [TearDown]
-        public void TearDown()
+        void Finish()
         {
             session.End();
             fileIOManager.End();
@@ -62,6 +62,7 @@ public void TearDown()
         [Test]
         public void RunTrials()
         {   
+            Start(false);
             int i = 0;
             foreach (var trial in session.Trials)
             {
@@ -84,6 +85,41 @@ public void RunTrials()
             {
                 Assert.AreEqual(trial.result["observation"], ++i);
             }
+            Finish();
+            
+            // read the file to check headers
+            string firstLine = File.ReadAllLines(Path.Combine(session.FullPath, "trial_results.csv"))[0];
+            Assert.AreEqual("directory,experiment,ppid,session_num,trial_num,block_num,trial_num_in_block,start_time,end_time,observation,null_observation", firstLine);           
+        }
+
+        [Test]
+        public void RunTrialsAdHocResultsAdd()
+        {   
+            Start(true);
+            int i = 0;
+            foreach (var trial in session.Trials)
+            {
+                trial.Begin();
+                trial.result["observation"] = ++i;
+                trial.result["null_observation"] = null;
+                trial.result["not_customheader_observation"] = "something";
+
+                Assert.AreSame(trial, session.CurrentTrial);
+                Assert.AreEqual(trial.number, session.currentTrialNum);
+
+                trial.End();
+            }
+
+            i = 0;
+            foreach (var trial in session.Trials)
+            {
+                Assert.AreEqual(trial.result["observation"], ++i);
+            }
+            Finish();
+
+            // read the file to check headers
+            string firstLine = File.ReadAllLines(Path.Combine(session.FullPath, "trial_results.csv"))[0];
+            Assert.AreEqual("directory,experiment,ppid,session_num,trial_num,block_num,trial_num_in_block,start_time,end_time,observation,null_observation,not_customheader_observation", firstLine);           
         }
 
 	}

Assets/UXF/Scripts/UI/OrderedResultDict.cs

@@ -0,0 +1,59 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Collections.Specialized;
+
+namespace UXF
+{
+    public class ResultsDictionary
+    {
+        private Dictionary<string, object> baseDict;
+        private bool allowAdHocAdding;
+
+        /// <summary>
+        /// Dictionary of results for a trial.
+        /// </summary>
+        /// <param name="initialKeys">Initial keys (e.g. headers) to add to dictionary</param>
+        /// <param name="allowAdHocAdding">Should extra keys be allowed to be added ad-hoc?</param>
+        public ResultsDictionary(IEnumerable<string> initialKeys, bool allowAdHocAdding)
+        {
+            baseDict = new Dictionary<string, object>();
+            this.allowAdHocAdding = allowAdHocAdding;
+            foreach (var key in initialKeys)
+            {
+                baseDict.Add(key, string.Empty);
+            }
+        }
+
+        /// <summary>
+        /// Access or set an observation
+        /// </summary>
+        /// <param name="key">Name (header) of the observation</param>
+        /// <returns></returns>
+        public object this[string key]
+        {
+            get { return baseDict[key]; }
+            set {
+                if (allowAdHocAdding || baseDict.ContainsKey(key))
+                {
+                    baseDict[key] = value;
+                }
+                else
+                {
+                    throw new KeyNotFoundException(string.Format("Custom header \"{0}\" does not exist!", key));
+                }
+            }
+        }
+
+        public Dictionary<string, object>.KeyCollection Keys
+        {
+            get
+            {
+                return baseDict.Keys;
+            }
+        }
+
+    }
+
+}

Assets/UXF/Scripts/UI/ResultsDict.cs

@@ -1,2 +1,2 @@
 timestamp,log_type,message
-1.979085,Log,Joining FileIOManagerThread
+1.353333,Warning,Warning: Session already exists! Continuing will overwrite

example_output/unit_test/test_trials/S001/log.csv

@@ -1,3 +1,3 @@
 {
-        
-    }
+    
+}

example_output/unit_test/test_trials/S001/participant_details.json

@@ -1,3 +1,3 @@
 {
-        
-    }
+    
+}

example_output/unit_test/test_trials/S001/settings.json

@@ -1,6 +1,6 @@
-experiment,ppid,session_num,trial_num,block_num,trial_num_in_block,start_time,end_time,observation,null_observation
-unit_test,test_trials,1,1,1,1,1.979085,1.979085,1,
-unit_test,test_trials,1,2,1,2,1.979085,1.979085,2,
-unit_test,test_trials,1,3,2,1,1.979085,1.979085,3,
-unit_test,test_trials,1,4,2,2,1.979085,1.979085,4,
-unit_test,test_trials,1,5,2,3,1.979085,1.979085,5,
+directory,experiment,ppid,session_num,trial_num,block_num,trial_num_in_block,start_time,end_time,observation,null_observation
+unit_test/test_trials/S001,unit_test,test_trials,1,1,1,1,1.353333,1.353333,1,
+unit_test/test_trials/S001,unit_test,test_trials,1,2,1,2,1.353333,1.353333,2,
+unit_test/test_trials/S001,unit_test,test_trials,1,3,2,1,1.353333,1.353333,3,
+unit_test/test_trials/S001,unit_test,test_trials,1,4,2,2,1.353333,1.353333,4,
+unit_test/test_trials/S001,unit_test,test_trials,1,5,2,3,1.353333,1.353333,5,