BioMotionLab / TUX

A framework for experiments in Unity and VR
https://biomotionlab.github.io/TUX/
Other
29 stars 4 forks source link

Multiple Feature Requests Regarding the Output Folder and File #46

Open A-Ivan opened 2 years ago

A-Ivan commented 2 years ago

Below are a multiple output file feature requests that go together:

  1. Set Experiment Root/Directory Folder

It would be great if there were a way to choose the root/directory output folder for the experiment. This folder would contain the individual participant folders (i.e., p1's folder, p2's folder, etc.), which would then contain their respective csv file.

  1. Automatic Output Folder and File Name Suggestion

Having set this root/directory folder, the naming of the participant folders could be automatically suggested, starting with P1. The directory folder could be searched for folders named P#, continuing off where the last number ended. For instance, if there already is a P1 folder and file, the system should automatically suggest/default to P2 (which of course could be edited in the "New Experiment Session" window if the user would like the change the file name and folder to a different one).

  1. Separate or the Same Folder for Individual Participant csv Files

Have an option, maybe in the Settings file or the "New Experiment Session" window, if each participant's output file is to be saved in their own separate folder (P1, P2, etc.) or if they should all be saved in the same folder. If I know my experiment will only need to generate one csv file per participant, it may be easier to process/analyze later if all the files are in the same folder.

  1. Overwrite csv File Option

If the output (csv) file already exists (say I run a study with particpant 1 2 times), a popup message currently appears stating that it already exists, which is great, but if I know it exists and I want to overwrite it, it would be great to have that option available.

The message could say something like "Output file xyz already exists, would you like to overwrite it?" Options: No (this would be the default selection to prevent errors), Yes

  1. Open Output Folder Button

In the "New Experiment Session" window, it would be great if there were a button to open the output folder in the operating system's file explorer. This would make it fast and easy to open the folder once an experiment is complete so you can check the generated csv files.

  1. Participant Number in Output csv File

It would be helpful if the participant number were to be included in the output csv file, preferably as the first column's data. This makes it easier later when analyzing the data, especially when analyzing multiple participant csv files at once, as the different files can be easily distinguished by this first column data.

AdamBebko commented 10 months ago

These all seem like very useful features. However as I mentioned in the discussion section, I no longer have the resources to add features to the project. If you feel these features would be useful to others please consider making a pull request, and I'd be happy to go over it with you.