Guide to adding new flags - galizia-lab/pyview GitHub Wiki

It's a very simple one step process! Just add a new row to the CSV file "view/flags_and_metadata_definitions/view_flags_definition.csv". (If you used MS-Excel/Libreoffice to edit the CSV file, please open the file after saving in a text editor and make sure the format is COMMA-separated. Sometimes, MS-Excel/Libreoffice saves data in TAB or SEMICOLON separated)

Here is a description of the columns:

Column Name	Description
Flag Name	Name of the flag. Please check if such a flag already exists
Flag Subgroup	Name of the subgroup. Look at other rows for subgroups or create a new one
Flag Description	Plain text description of the function of the flag
Selectable Options	Non-exhaustive list of values this flag can take and their descriptions. Look at this column for other rows for it's format. Used in the drop down menus in the flags selection Widget of view-GUI
Flag Value Type	expected data type of the flag (E.g.: int, str). Can be more than one, e.g.: "int,str"
Flag Default Value	a default value for this flag (must be consistent with it's expected data type)
Flag Checks	a string in which "{flag}" will be substituted with its value and executed in Python. E.g.: "{flag} >= 0"
Error Message	the error message that is displayed when a "flag check" fails.