diff --git a/Manual.html b/Manual.html index 6e99ff7..a6b01e4 100644 --- a/Manual.html +++ b/Manual.html @@ -3029,7 +3029,8 @@
To make things easier, I will establish a few rules used throughout this section.
Anytime text is formatted like this (X)
, it refers to a button, editable field, drop-down menu, or in general a control on the GUI. The number at the end, here an (X)
signifies which section of the GUI this control is located in. As an example, csv2xlsx (4)
is the button used to convert csv-files to xlsx-files, located under 4. Auxiliary Utilities.
The main task of this program is to generate a suitable configuration file which can be used with the R-Script GFA_Evaluation.R
bundled alongside this program. For details on its functioning, see documentation on GFA_Evaluation.R
Configuration files can be handled by this program in three ways: 1. New Config in Folder (1)
This allows you to create a config-file for a new project 2. Edit existing Config (1)
This allows you to load an existing config file for editing 3. Double-clicking a configuration previously used under Configurations and Image-renaming (4)
This effectively works the same as Number 2. 4. You may also drag and drop a config file onto the greyed-out field (1)
to the right of those two buttons.
Under curr. loaded Config (3)
, the path to a configuration-file will be visible if the user has chosen a path already - by loading a config, or by manually selecting a config’s location when clicking New Config in Folder
. When saving or previewing a configuration, the program will attempt to validate the inputs given by the user. Certain inputs however cannot be validated with certainty by the program. In these cases, the user is asked to manually confirm or discard their choices. These popups differentiate between mild warnings (yellow warning signs) and severe warnings (red x-crosses). This depends on how severe a false decision may be, or how vital it is for GFA_main()
’s functioning to have correct inputs. ### Selecting and Editing an R-Script
Under curr. loaded Config (3)
, the path to a configuration-file will be visible if the user has chosen a path already - by loading a config, or by manually selecting a config’s location when clicking New Config in Folder
.
+When saving or previewing a configuration, the program will attempt to validate the inputs given by the user. Certain inputs however cannot be validated with certainty by the program. In these cases, the user is asked to manually confirm or discard their choices. These popups differentiate between mild warnings (yellow warning signs) and severe warnings (red x-crosses). This depends on how severe a false decision may be, or how vital it is for GFA_main()
’s functioning to have correct inputs.
To complement the config-files generated, the user may generate a barebones “starter”-R-Script which will call GFA_main()
.
R-Scripts can be handled by this program in three ways: 1. New R-StarterScript (2)
This allows you to create a new R-Script for a new project 2. Edit existing R-StarterScript (2)
This allows you to load an existing R-Script for editing 3. Double-clicking an R-Script previously used under R Scripts (4)
This effectively works the same as Number 2. 4. You may also drag and drop a config file onto the greyed-out field (2)
1 to the right of those two buttons.
1 Note that this is not the same greyed-out field that is used for dropping configurations.
Under curr. loaded R-Script (3)
, an R-Script is visible. If the field is empty, attempting to write to a file will result in the program asking the user to select an appropriate location.
Under curr. loaded R-Script (3)
, an R-Script is visible.
+If the field is empty, attempting to write to a file will result in the program asking the user to select an appropriate location.
First off it makes sense to take a look at the example configurations and how the results of them look. Examples can be found under XX\res\Examples
, where XX
is the folder in which this program resides. They are not meant to display sensible data, the data may be unrealistic. The intention of the reference files is mostly to give simple visualisation of a configuration. They also don’t showcase all potential cases, as those are just too many.
Configurations can be edited after being loaded (see section on config-selection).
If a configuration is leaded, its path will be visible under curr. loaded Config (3)
@@ -5180,7 +5186,7 @@
See accompanying license file. License of used code can be found in dist\res\CombinedLicenses.txt
, as best as could be retrieved.
See accompanying license file. Licenses of used code can be found in dist\res\CombinedLicenses.txt
, as best as could be retrieved.
To make things easier, I will establish a few rules used throughout this section.
Anytime text is formatted like this (X)
, it refers to a button, editable field, drop-down menu, or in general a control on the GUI. The number at the end, here an (X)
signifies which section of the GUI this control is located in. As an example, csv2xlsx (4)
is the button used to convert csv-files to xlsx-files, located under 4. Auxiliary Utilities.
The main task of this program is to generate a suitable configuration file which can be used with the R-Script GFA_Evaluation.R
bundled alongside this program. For details on its functioning, see documentation on GFA_Evaluation.R
Configuration files can be handled by this program in three ways: 1. New Config in Folder (1)
This allows you to create a config-file for a new project 2. Edit existing Config (1)
This allows you to load an existing config file for editing 3. Double-clicking a configuration previously used under Configurations and Image-renaming (4)
This effectively works the same as Number 2. 4. You may also drag and drop a config file onto the greyed-out field (1)
to the right of those two buttons.
Under curr. loaded Config (3)
, the path to a configuration-file will be visible if the user has chosen a path already - by loading a config, or by manually selecting a config’s location when clicking New Config in Folder
. When saving or previewing a configuration, the program will attempt to validate the inputs given by the user. Certain inputs however cannot be validated with certainty by the program. In these cases, the user is asked to manually confirm or discard their choices. These popups differentiate between mild warnings (yellow warning signs) and severe warnings (red x-crosses). This depends on how severe a false decision may be, or how vital it is for GFA_main()
’s functioning to have correct inputs. ### Selecting and Editing an R-Script
Under curr. loaded Config (3)
, the path to a configuration-file will be visible if the user has chosen a path already - by loading a config, or by manually selecting a config’s location when clicking New Config in Folder
.
+When saving or previewing a configuration, the program will attempt to validate the inputs given by the user. Certain inputs however cannot be validated with certainty by the program. In these cases, the user is asked to manually confirm or discard their choices. These popups differentiate between mild warnings (yellow warning signs) and severe warnings (red x-crosses). This depends on how severe a false decision may be, or how vital it is for GFA_main()
’s functioning to have correct inputs.
To complement the config-files generated, the user may generate a barebones “starter”-R-Script which will call GFA_main()
.
R-Scripts can be handled by this program in three ways: 1. New R-StarterScript (2)
This allows you to create a new R-Script for a new project 2. Edit existing R-StarterScript (2)
This allows you to load an existing R-Script for editing 3. Double-clicking an R-Script previously used under R Scripts (4)
This effectively works the same as Number 2. 4. You may also drag and drop a config file onto the greyed-out field (2)
1 to the right of those two buttons.
1 Note that this is not the same greyed-out field that is used for dropping configurations.
Under curr. loaded R-Script (3)
, an R-Script is visible. If the field is empty, attempting to write to a file will result in the program asking the user to select an appropriate location.
Under curr. loaded R-Script (3)
, an R-Script is visible.
+If the field is empty, attempting to write to a file will result in the program asking the user to select an appropriate location.
First off it makes sense to take a look at the example configurations and how the results of them look. Examples can be found under XX\res\Examples
, where XX
is the folder in which this program resides. They are not meant to display sensible data, the data may be unrealistic. The intention of the reference files is mostly to give simple visualisation of a configuration. They also don’t showcase all potential cases, as those are just too many.
Configurations can be edited after being loaded (see section on config-selection).
If a configuration is leaded, its path will be visible under curr. loaded Config (3)
@@ -5180,7 +5186,7 @@
See accompanying license file. License of used code can be found in dist\res\CombinedLicenses.txt
, as best as could be retrieved.
See accompanying license file. Licenses of used code can be found in dist\res\CombinedLicenses.txt
, as best as could be retrieved.