diff --git a/Home.md b/Home.md index d72fd40..ea4662b 100644 --- a/Home.md +++ b/Home.md @@ -74,17 +74,17 @@ On top of this generic information, there is also some data that is unique to SN This information panel is purely for validation purposes and it is not possible to change any of the values from this area since this is data from inside the file that was made when the file was created. There are three parameters that do get added to the File Information area once a file has been selected that can be changed. None of these additional parameters need to be set for the analysis to function. These parameters are: - Age - Used to calculate the DPF of the participant. If Age is not specified, the value will be set to 25 automatically -- Gender - Used as a filter option to filter results at the end of the analysis. This is not currently implemented and will have no effect +- Gender - Used as a filter option to filter results at the end of the analysis. This is not implemented and currently will have no effect. - Group - Used as a filter option to filter results at the end of the analysis.. If Group is not specified, the value will be set to "Default" -A "Why are these useful?" button can be found below this area and when clicked will restate this information in a popup window. +A "Why are these useful?" button can be found below this area and when clicked, will restate this information in a popup window. This is not implemented and currently will have no effect. ## Loaded files ## -When files are loaded either from opening a singular file or opening a whole folder, all valid files will be shown in this area, along with a progress bar. Clicking on a file will bring up its information in the File Information area and allow for changes to the participants Age, Gender, and Group. When the analysis is running, the progress bar will update based on how far the participant has been processed. Right clicking the file will bring up two buttons: -- Reveal - Opens a file browser to the location that this file is stored on disk -- Remove - Unloads and removes the file, preventing it from being processed. This does not modify the file on disk. If the participant is removes after an analysis, their data will be still included in the analysis. To get data without this file, the analysis will have to be run again +When files are loaded either from opening a singular file or opening a whole folder, all valid files will be shown in this area, along with a 28-stage progress bar. Clicking on a file will bring up its information in the File Information area and will allow for changes to be made to the participants Age, Gender, and Group. When the processing of files is running, the 28-stage progress bar will update based on how far the participant has been processed. Each participant will have their own progress bar denoting how far their file has been processed. Right clicking a file in the Loaded Files area will bring up two buttons: +- Reveal - Opens a file browser set to the location that this file is stored on disk +- Remove - Unloads and removes the file, preventing it from being processed. This does not modify the file on disk. If the participant is removes after they have been fully processed, their data will still be included in the analysis. To get an analyis without this file, all participants will have to be processed again. -The analysis will finish when all progress bars have completed. If the analysis completes and a progress bar has not finished, then something went wrong processing that file. Checking the logs could provide insight into what went wrong. +The processing will finish shortly after all progress bars have completed. If the processing completes and a progress bar has not finished, then something went wrong processing that file. Checking the logs could provide insight into what went wrong. ## Parameters ## When performing a fNIRS analysis, these parameters are some of the most important settings and it is crucial that they are correct for the study that is being performed. FLARES exposes most of the parameters needed for an analysis allowing for immense customizability. These parameters have been broken down into subcategories in an attempt to keep them simple. These parameters are also shown in the order that they will be applied, and logical values have been applied by default. Below is a list of the submenus: