Create ScreenRayTracker.cs #129

JAQuent · 2022-05-09T11:17:47Z

No description provided.

I've added the possibility to provide trials using tab-separated-values (tsv) so people can use "," in strings.

JAQuent · 2022-05-10T04:39:15Z

In additition to the screen tracker I also quickly edited the CSV session builder and created a TSV session builder with it because people might want to use "," in their strings.

jackbrookes · 2022-05-19T07:51:18Z

Hi, I don't have time to review right now but I can see several problems immediately, that would need to be addressed before merging. I will add comments.

jackbrookes · 2022-05-19T07:52:45Z

Assets/UXF/Scripts/Etc/UXFDataTable.cs

+        /// <summary>
+        /// Build a table from lines of TSV text.
+        /// </summary>
+        /// <param name="tsvLines"></param>
+        /// <returns></returns>
+        public static UXFDataTable FromTSV(string[] tsvLines)
+        {
+            string[] headers = tsvLines[0].Split('\t');
+            var table = new UXFDataTable(tsvLines.Length - 1, headers);
+
+            // traverse down rows
+            for (int i = 1; i < tsvLines.Length; i++)
+            {
+                string[] values = tsvLines[i].Split('\t');
+
+                // if last line, just 1 item in the row, and it is blank, then ignore it
+                if (i == tsvLines.Length - 1 && values.Length == 1 && values[0].Trim() == string.Empty ) break;
+
+                // check if number of columns is correct
+                if (values.Length != headers.Length) throw new Exception($"TSV line {i} has {values.Length} columns, but expected {headers.Length}");
+
+                // build across the row
+                var row = new UXFDataRow();
+                for (int j = 0; j < values.Length; j++)
+                    row.Add((headers[j], values[j].Trim('\"')));
+
+                table.AddCompleteRow(row);
+            }
+
+            return table;
+        }


this should probably be a separate Pull Request, and made generic with the CSV version to accept a delimiter, rather than copying the code

Completely agree :)

Also, just changing the experimenter builder is not enough because then what might happen is that a variable such as a string that is to be displayed to the participant contains and a comma, which UXF then tries to save, which doesn't work if the the output file is an .csv. I currently have work-around where I just replace a comma with an underscore before it is saved but tihis prevents me to copy the data from the input file to the result file.

jackbrookes · 2022-05-19T07:53:28Z

Assets/UXF/Scripts/SessionBuilders/TSVExperimentBuilder.cs

+namespace UXF
+{
+    public class TSVExperimentBuilder : MonoBehaviour, IExperimentBuilder
+    {
+
+        [Tooltip("The name key in the settings that contains the name of the trial specification file.")]
+        [SerializeField] private string tsvFileKey = "trial_specification_name";
+        [Tooltip("Enable to copy all settings from each trial in the TSV file to the the trial results output.")]
+        [SerializeField] private bool copyToResults = true;
+
+        /// <summary>
+        /// Reads a TSV from filepath as specified in tsvFileKey in the settings.
+        /// The TSV file is used to generate trials row-by-row, assigning a setting per column.
+        /// </summary>
+        /// <param name="session"></param>
+        public void BuildExperiment(Session session)
+        {
+            // check if settings contains the tsv file name
+            if (!session.settings.ContainsKey(tsvFileKey))
+            {
+                throw new Exception($"TSV file name not specified in settings. Please specify a TSV file name in the settings with key \"{tsvFileKey}\".");
+            }
+
+            // get the tsv file name
+            string tsvName = session.settings.GetString(tsvFileKey);
+
+            // check if the file exists
+            string tsvPath = Path.GetFullPath(Path.Combine(Application.streamingAssetsPath, tsvName));
+            if (!File.Exists(tsvPath))
+            {
+                throw new Exception($"TSV file at \"{tsvPath}\" does not exist!");
+            }
+
+            // read the tsv file
+            string[] tsvLines = File.ReadAllLines(tsvPath);
+
+            // parse as table
+            var table = UXFDataTable.FromTSV(tsvLines);
+
+            // build the experiment.
+            // this adds a new trial to the session for each row in the table
+            // the trial will be created with the settings from the values from the table
+            // if "block_num" is specified in the table, the trial will be added to the block with that number
+            session.BuildFromTable(table, copyToResults);
+        }
+    }
+
+}


same with this, it should be generic with specified delimiter

jackbrookes · 2022-05-19T07:53:48Z