Column Data Types and Values

[AKostiv8]

Scenarios

Scenarios Table

• Scenario_name - text type; text input; no predefined values; no validation
• IndividualId - text type; dropdown multiple selection input; options come from Individuals$IndividualBiometrics sheet
• PopulationId - text type; dropdown selection input; options come from Populations$PopulationName sheet;
• ReadPopulationFromCSV - text type; text input; no predefined values; no validation
• ModelParameterSheets - text type; text input; no predefined values; no validation
• ApplicationProtocol - text type; text input; no predefined values; no validation
• SimulationTime - text type with the integer numeric values split by ";", modal window input with the only integer values allowed
• SimulationTimeUnit - text type; dropdown selection input; options come from ospsuite::ospUnits
• SteadyState - boolean type; checkbox input; strict validation -> allowed values: true/false
• SteadyStateTime - text type; text input; no predefined values; no validation
• SteadyStateTimeUnit - text type; dropdown selection input; options come from ospsuite::ospUnits
• ModelFile - text type; text input; no predefined values; no validation
• OutputPathsIds - text type; text input; no predefined values; no validation

OutputPaths Table

• OutputPathId - text type; text input;
• OutputPath - text type; text input;

Individuals

IndividualBiometrics Table

• IndividualId - text type; text input; no predefined values; no validation
• Species - text type; dropdown selection input; options come from ospsuite::Species
• Population - text type; text input;
• Gender - text type; dropdown selection input; options come from ospsuite::Gender
• Weight - numeric (integer) type; text input; min/max value ???
• Height - numeric (integer) type; text input; min/max value ???
• Age - numeric (integer) type; text input; min/max value ???

Populations

Demographics Table

• PopulationName - text type; text input; no predefined values; no validation
• species - text type; dropdown selection input; options come from ospsuite::Species
• population - text type; text input;
• numberOfIndividuals - numeric (integer) type; text input; min/max value ???
• proportionOfFemale - numeric (integer) type; text input; min/max value ???
• weightMin - numeric (integer) type; text input
• weightMax - numeric (integer) type; text input
• weightUnit - text type; dropdown selection input; options come from ospsuite::ospUnits
• heightMin - numeric (integer) type; text input
• heightMax - numeric (integer) type; text input
• heightUnit - text type; dropdown selection input; options come from ospsuite::ospUnits
• ageMin - numeric (integer) type; text input
• ageMax - numeric (integer) type; text input
• BMIMin - numeric (integer) type; text input
• BMIMax - numeric (integer) type; text input
• BMIUnit - text type; dropdown selection input; options come from ospsuite::ospUnits

Plots

DataCombined Table

• DataCombinedName - text type; text input; no predefined values; no validation
• dataType - text type; dropdown selection input; options: ['simulated', 'observed'] ???
• label - text type; text input; no predefined values; no validation
• scenario - text type; text input; no predefined values; no validation
• path - text type; text input; no predefined values; no validation
• dataSet - text type; text input; no predefined values; no validation
• group - text type; text input; no predefined values; no validation
• xOffsets - numeric (integer) type; text input
• xOffsetsUnits - text type; dropdown selection input; options come from ospsuite::ospUnits ???
• yOffsets - numeric (integer) type; text input
• yOffsetsUnits - text type; dropdown selection input; options come from ospsuite::ospUnits ???
• xScaleFactors - numeric (integer) type; text input
• yScaleFactors - numeric (integer) type; text input

plotConfigurations Table

• plotID - text type; text input; no predefined values; no validation
• dataCombinedName - text type; text input; no predefined values; no validation
• plotType - text type; dropdown selection input; options: ['individual'] ???
• title - text type; dropdown selection input; options come from ospsuite::ospUnits ???
• xUnit - text type; dropdown selection input; options come from ospsuite::ospUnits ???
• yUnit - text type; dropdown selection input; options come from ospsuite::ospUnits ???
• xAxisScale - text type; dropdown selection input; options: ['lin', 'log'] ???
• yAxisScale - text type; dropdown selection input; options: ['lin', 'log'] ???
• xAxisLimits - numeric (integer) type; text input
• yAxisLimits - numeric (integer) type; text input
• quantiles - numeric type; text input
• foldDistance - numeric type; text input

plotGrids Table

• name - text type; text input; no predefined values; no validation
• plotIDs - text type; text input; no predefined values; no validation
• title - text type; text input; no predefined values; no validation

[AKostiv8]

@Felixmil / @PavelBal , please review:

• column data type;
• input method (dropdown/text input/modal window etc.);
• predefined input options (applicable for dropdown)

[PavelBal]

Scenarios

Scenarios Table

• Scenario_name - no validation
  • Validation: Duplicates not allowed
• IndividualId - text type; dropdown multiple single selection input; options come from Individuals$IndividualBiometrics sheet, column IndividualId. Empty values allowed.
• PopulationId - text type; dropdown single selection input; options come from Populations$PopulationName sheet; Empty values allowed.
• ReadPopulationFromCSV - boolean type; default is FALSE (unselected). Empty value is interpreted as FALSE (could be converted on loading the file?)
• ModelParameterSheets - text type; text dropdown multiselect input; options come from ModelParameters.xlsx sheet names. Empty values allowed.
• ApplicationProtocol - text type; text dropdown single select input; options come from ApplicationParameters.xlsx sheet names. Empty values allowed (== <unchanged>.
• SimulationTime - will open a separate issue
• SimulationTimeUnit - will open a separate issue
• SteadyState - boolean type; checkbox input; strict validation -> allowed values: true/false. Empty value is interpreted as FALSE (could be converted on loading the file?)
• SteadyStateTime - text type; text input; no predefined values; no validation only positive (>0) numerical values are allowed
• SteadyStateTimeUnit - text type; dropdown selection input; options come from ospsuite::ospUnits$Time
• ModelFile - text type; text input; no predefined values; no validation
  • Optional nice to have - a model view that lists all *.pkml* files located in the folderModels/Simulations`
• OutputPathsIds - text type; text input dropdown multiselect, values come from the sheet OutputPaths, column OutputPathId

OutputPaths Table

• OutputPathId - text type; text input; no duplicate entries allowed
• OutputPath - text type; text input;

Individuals

IndividualBiometrics Table

• IndividualId - text type; text input; no predefined values; no validation
• Species - text type; dropdown selection input; options come from ospsuite::Species
• Population - text type; text input; dropdown single selection, IF Species == Human, values come from ospsuite::HumanPopulation
• Gender - text type; dropdown selection input; options come from ospsuite::Gender
• Weight - numeric (integer) type; text input; value must be positive
• Height - numeric (integer) type; text input; value must be positive
• Age - numeric (integer) type; text input; value must be positive
• Protein - will open a separate issue
• Ontogeny - will open a separate issue
• IndividualParameterSheets - text type; dropdown multiselect input; options come from Individuals.xlsx sheet names (excluding the IndividualBiometrics sheet). Empty values allowed.

Populations

Demographics Table

• PopulationName - text type; text input; no predefined values; no validation
• species - text type; dropdown selection input; options come from ospsuite::Species
• population - text type; text input; dropdown single selection, IF Species == Human, values come from ospsuite::HumanPopulation
• numberOfIndividuals - numeric (integer) type; text input; value must be positive
• proportionOfFemale - numeric (integer) type; text input; [0...100]
• weightMin - numeric (integer) type; text input
• weightMax - numeric (integer) type; text input
• weightUnit - text type; dropdown selection input; options come from ospsuite::ospUnits$Mass
• heightMin - numeric (integer) type; text input
• heightMax - numeric (integer) type; text input
• heightUnit - text type; dropdown selection input; options come from ospsuite::ospUnits$Length
• ageMin - numeric (integer) type; text input
• ageMax - numeric (integer) type; text input
• BMIMin - numeric (integer) type; text input
• BMIMax - numeric (integer) type; text input
• BMIUnit - text type; dropdown selection input; options come from ospsuite::ospUnits$BMI
• Protein - will open a separate issue
• Ontogeny - will open a separate issue

Plots

DataCombined Table

• DataCombinedName - text type; text input; no predefined values; no validation
• dataType - text type; dropdown selection input; options: ['simulated', 'observed']
• label - text type; text input; no predefined values; no validationcannot be empty
• scenario - text type; dropdown single selection input; options come from Scenarios$Scenarios sheet, column Scenario_names; Disabled if dataType == observed
• path - text type; text input; User can enter a value OR select from drop-down, values come from Scenarios$OutputPaths, column "OutputPath"; Disabled if dataType == observed
• dataSet - text type; should be a drop-down showing available data sets, but we need a separate issue for this
• group - text type; text input; no predefined values; no validation
  • A killer-fieature would be: drop down with selection of groups that are already available for this DataCombined, i.e., in any row with this DataCombinedName. And option "Add new"
• xOffsets - numeric (integer) type; text input
• xOffsetsUnits - text type; dropdown selection input; options come from ospsuite::ospUnits ??? First select a dimention (ospsuite::Dimensions), the the unit from this dimension. See esqlabsR::startUnitConverter() for example
• yOffsets - numeric (integer) type; text input
• yOffsetsUnits - text type; dropdown selection input; options come from ospsuite::ospUnits ??? First select a dimention (ospsuite::Dimensions), the the unit from this dimension. See esqlabsR::startUnitConverter() for example
• xScaleFactors - numeric (integer) type; text input
• yScaleFactors - numeric (integer) type; text input

plotConfigurations Table

• plotID - text type; text input; no predefined values; no validation
• dataCombinedName - text type; dropdown single selection, values come from DataCombined sheet
• plotType - text type; dropdown selection input; options: ['individual', 'population', 'observedVsSimulated', 'residualsVsSimulated', 'residualsVsTime']
• title - text type; no predefined values; no validation; empty values allowed
• xUnit - text type; dropdown selection input; options come from ospsuite::ospUnits ??? First select a dimention (ospsuite::Dimensions), the the unit from this dimension. See esqlabsR::startUnitConverter() for example. Pre-selected dimension is Time
• yUnit -text type; dropdown selection input; options come from ospsuite::ospUnits ??? First select a dimention (ospsuite::Dimensions), the the unit from this dimension. See esqlabsR::startUnitConverter() for example
• xAxisScale - text type; dropdown selection input; options: ['lin', 'log']
• yAxisScale - text type; dropdown selection input; options: ['lin', 'log']
• xAxisLimits - numeric (integer) type; text input. Two values separated by a ,, second value must be > first value
• yAxisLimits - numeric (integer) type; text input. Two values separated by a ,, second value must be > first value
• aggregation - Drop-down, values from ospsuite::DataAggregationMethods. Disabled if plotType != population. May be empty
• quantiles - numeric type; triple of values, each value in range (>0...1] Disabled if plotType != population. May be empty
• foldDistance - numeric type; list of numeric values >1 separated by ','

--------------------tbc----------------

plotGrids Table

• name - text type; text input; no predefined values; no validation
• plotIDs - text type; text input; no predefined values; no validation
• title - text type; text input; no predefined values; no validation

[PavelBal]

@AKostiv8 Changes and additions in bold.