Skip to main content
. 2023 Feb 25;10:113. doi: 10.1038/s41597-023-02013-5

Table 6.

Configuration fields used to define liveability indicators in the ‘indicator_setup’ worksheet of the configuration file.

Field Description
indicators Short variable name for indicator, with domain grouping
domain A conceptual domain under which the indicators have been categorised
scale The geographic scale of the indicator
ind_plain A slightly longer plain English name for a variable, where possible
tags Permutations of indicators using soft or hard thresholding22
locale The study region to which this indicator relates (for national study, this is an asterisk indicating all 21 cities)
ntnl_scripts Whether the indicator has been incorporated into the scripted workflow
updated? The date that this indicator was last incorporated or updated in the scripted workflow
unit_level_description Description of this indicator as it relates to address points
aggregate_description Description of this indicator as it relates to areas
threshold_aggregate_description Description of this indicator as it relates to areas with evaluation as a percentage based on a threshold split
notes Any notes about this indicator
policy_locale Whether this indicator relates to policies in specific study regions
policy_wording Wording of any policy reference for this indicator
policy_reference The policy reference for this indicator
data_sources A shorthand summary of data sources used, where completed
Query The final main SQL query used to construct this indicator from intermediary tables as part of the scripted workflow
Source Linkage query portion for the source intermediary SQL database tables used to construct this indicator
agg_form The form of this indicator once aggregated (e.g., an average, percentage, ratio or Z-score)
agg_scale Any scaling to be applied to aggregate indicators (e.g., multiplying a proportion by 100 to represent a percentage)
agg_alt_variable Whether the aggregate statistic is calculated using an alternate table to the address level indicator (which may not exist in some cases)
agg_standard Whether the indicator is to have weights applied on aggregation, e.g., to represent dwellings or persons
agg_split_greq A split point for evaluating thresholds meeting a certain value
units Units of the indicator (can include html for web map descriptions of area level indicators)
polarity Polarity (e.g., Ascending or Descending)