{"calculationMethod-array": [
{
"identifier": "1",
"label": "Sum of one or more metric types divided one or more metric types",
"description": "Divide a single metric type or sum of metric types (of the same period type as each other) by another single metric type or group (of the same period type as each other). Where time period types are the same an exact period will be used. Where numerator and denominator period types are different, the logic used is described below. This is then multiplied by the multiple value. Where metric types have an API link, any area levels marked as imported will not be calculated. If any of the values are either supp",
"fields": [
{
"label": "Numerator",
"identifier": "Numerator",
"description": "The metric type to use as a numerator"
},
{
"label": "Denominator",
"identifier": "Denominator",
"description": "The metric type to use as a denominator"
},
{
"label": "Multiple",
"identifier": "Multiple",
"description": "Value to multiply the results of the numerator and denominator division by"
}
]
},
{
"identifier": "7",
"label": "Year to date",
"description": "Sum of all values from a selected metric type whose periods fit within the destination metric type's time period. So for example it could be all quarterly metric types that fit within a calendar year, regardless of whether all quarters have values. If any of the values within the larger period are either suppressed or a mixture of suppressed and missing, there will not be a calculated value and the value will be marked as suppressed. If any of the values within the larger period are marked as missing, there",
"fields": [
{
"label": "Year to date from",
"identifier": "Year_To_Date_From",
"description": "Metric type from which to calculate year to date values"
},
{
"label": "Include full periods",
"identifier": "Include_Full_Periods",
"description": "Enter 1 if all periods need to have data to get a value, and 0 if any periods being available can be used for a year to date value"
}
]
},
{
"identifier": "8",
"label": "Score (top quintile 6, bottom quintile 0, others 3)",
"description": "Values from the selected metric type are put into quintiles and scored. The quintiles are generated by grouping by time period and area level, with the exception of local authorities which are grouped by area types in the single tier and district (STLAD) group. Values equal or greater than the top quintile score 6, values equal to or less than the bottom quintile score 0, and others score 3. Comments and missing or suppressed flags are copied from the source value.",
"fields": [
{
"label": "Metric type to score",
"identifier": "Metric_Type_To_Score",
"description": "Metric type to generate the scores for"
}
]
},
{
"identifier": "9",
"label": "Score (top quintile 3, bottom quintile 1, others 2)",
"description": "Values from the selected metric type are put into quintiles and scored. The quintiles are generated by grouping time period and area level, with the exception of local authorities which are grouped by area types in the single tier and district (STLAD) group. Values equal or greater than the top quintile score 3, values equal to or less than the bottom quintile score 1, and others score 2. Comments and missing or suppressed flags are copied from the source value.",
"fields": [
{
"label": "Metric type to score",
"identifier": "Metric_Type_To_Score",
"description": "Metric type to generate the scores for"
}
]
},
{
"identifier": "10",
"label": "Single metric type division (of same time period and always same divisor period)",
"description": "Divide a single metric type by another (always using the same denominator time period, which is set using its identifier below) and then multiply by the measure. Metric types should be of same time period type and can be the same metric type for numerator and denominator. Comments, and whether the value is missing or suppressed will be taken from the numerator.",
"fields": [
{
"label": "Numerator",
"identifier": "Numerator",
"description": "The metric type to use as a numerator"
},
{
"label": "Denominator",
"identifier": "Denominator",
"description": "The metric type to use as a denominator"
},
{
"label": "Denominator time period",
"identifier": "Denominator_Time_Period",
"description": "The time period to use for the denominator",
"lookupTable": "TimePeriod",
"lookupId": "ID",
"lookupDisplay": "Identifier"
},
{
"label": "Multiple",
"identifier": "Multiple",
"description": "Value to multiply the results of the numerator and denominator division by"
}
]
},
{
"identifier": "11",
"label": "Single metric type division (of same time period or using latest numerator)",
"description": "Divide a single metric type by another (using the same period or, where that period does not exist, we use the latest prior numerator period) and then multiply by the measure.",
"fields": [
{
"label": "Numerator",
"identifier": "Numerator",
"description": "The metric type to use as a numerator"
},
{
"label": "Denominator",
"identifier": "Denominator",
"description": "The metric type to use as a denominator"
},
{
"label": "Multiple",
"identifier": "Multiple",
"description": "Value to multiply the results of the numerator and denominator division by"
}
]
},
{
"identifier": "12",
"label": "Weighted aggregation from selected level",
"description": "Aggregate to other area levels from a single selected level, weighted by a selected metric type. If raw values are imported and should not be calculated, they can be added to the area type to exclude list. If any of the metric types are suppressed or a mixture of suppressed and missing then the calculated value will be marked as suppressed. If any of the values are marked as missing then the calculated value will show as missing. Comments will not be included.",
"fields": [
{
"label": "Weighted by",
"identifier": "Weighted_By",
"description": "Metric type by which values aggregated from LSOA are weighted"
},
{
"label": "Area type to exclude",
"identifier": "Area_Type_To_Exclude",
"description": "Area type to exclude from aggregation",
"lookupTable": "GeoAreaLevel",
"lookupId": "ID",
"lookupDisplay": "Identifier"
},
{
"label": "Area type to aggregate from",
"identifier": "Area_Type_To_Aggregate",
"description": "Area type from which other areas are aggregated",
"lookupTable": "GeoAreaLevel",
"lookupId": "ID",
"lookupDisplay": "Identifier"
}
]
},
{
"identifier": "13",
"label": "Metric type multiplied by multiple",
"description": "Multiply a metric type value by a numeric value. If a value is missing or suppressed then the calculated value will be the same. Comments from the original value will be copied across.",
"fields": [
{
"label": "Metric type to multiply",
"identifier": "Metric_Type_To_Multiply",
"description": "Metric type whose values are to be multiplied"
},
{
"label": "Multiple",
"identifier": "Multiple",
"description": "Value to multiply the metric type by"
}
]
},
{
"identifier": "14",
"label": "Score (top quintile 0, bottom quintile 6, others 3)",
"description": "Values from the selected metric type are put into quintiles and scored. The quintiles are generated by grouping time period and area level, with the exception of local authorities which are grouped by area types in the single tier and district (STLAD) group. Values equal or greater than the top quintile score 0, values equal to or less than the bottom quintile score 6, and others score 3. Comments and missing or suppressed flags are copied from the source value.",
"fields": [
{
"label": "Metric type to score",
"identifier": "Metric_Type_To_Score",
"description": "Metric type to generate the scores for"
}
]
},
{
"identifier": "15",
"label": "Score (top quintile 1, bottom quintile 3, others 2)",
"description": "Values from the selected metric type are put into quintiles and scored. The quintiles are generated by grouping time period and area level, with the exception of local authorities which are grouped by area types in the single tier and district (STLAD) group. Values equal or greater than the top quintile score 1, values equal to or less than the bottom quintile score 3, and others score 2. Comments and missing or suppressed flags are copied from the source value.",
"fields": [
{
"label": "Metric type to score",
"identifier": "Metric_Type_To_Score",
"description": "Metric type to generate the scores for"
}
]
},
{
"identifier": "16",
"label": "Difference from earlier period",
"description": "Metric type to store the difference between two relative periods in time of a metric type. The number of periods difference can be changed. Comments, and whether an item is missing or suppressed are taken from the latest of the two periods.",
"fields": [
{
"label": "Metric type",
"identifier": "Metric_Type",
"description": "Metric type to show difference between periods for"
},
{
"label": "Number of previous periods",
"identifier": "Previous_Periods",
"description": "Value changed between this number of previous periods"
}
]
},
{
"identifier": "17",
"label": "Sum of metric types",
"description": "Values for metric types are added together. All metric types must be of the same period type. If any of the values are suppressed, or a mixture of missing and suppressed, then the value will be suppressed. If any of the values are missing then the value will show as missing. Comments are not used.",
"fields": [
{
"label": "Metric types",
"identifier": "Metric_Types",
"description": "Metric types to sum together"
}
]
},
{
"identifier": "18",
"label": "Subtract metric types",
"description": "Subtract one or more metric types from the first. All of the metric types must be of the same period type. Comments, and the missing or suppressed status is taken first from the 'Subtract from' metric type, then the 'Subtracted' metric types.",
"fields": [
{
"label": "Subtract from",
"identifier": "Subtract_From_Metric_Type",
"description": "Metric type from which other should be subtracted"
},
{
"label": "Subtracted",
"identifier": "Subtracted_Metric_Type",
"description": "Metric type or types to be subtracted"
}
]
},
{
"identifier": "19",
"label": "Reverse percentages",
"description": "Create an inverse of the percentage. Comments, and the missing or suppressed status is taken from the original value.",
"fields": [
{
"label": "Metric type",
"identifier": "Metric_Type",
"description": "Metric type to invert percentage"
}
]
},
{
"identifier": "20",
"label": "Mean value",
"description": "From a particular measure and dimension generate the mean value",
"fields": [
{
"label": "Measure",
"identifier": "Measure",
"description": "Identifier for the measure from which the average will be generated",
"lookupTable": "Measure",
"lookupId": "Id",
"lookupDisplay": "Identifier"
},
{
"label": "Circumstance",
"identifier": "Circumstance",
"description": "Identifier for the circumstance in the measure from which the average will be generated",
"lookupTable": "Dimension",
"lookupId": "Id",
"lookupDisplay": "Identifier"
}
]
},
{
"identifier": "21",
"label": "Per day",
"description": "Single metric type or types divided by the number of days in the applicable time period, multiplied by the multiple",
"fields": [
{
"label": "Numerator",
"identifier": "Numerator",
"description": "The metric type(s) to use as a numerator"
},
{
"label": "Multiple",
"identifier": "Multiple",
"description": "Value to multiply the results of the numerator and number of days division by"
}
]
},
{
"identifier": "22",
"label": "Reverse rank weighted average value",
"description": "Aggregate reverse rank to other area levels from a single selected level, weighted by a selected metric type. If area types should not be calculated, they can be added to the area type to exclude list. If any of the metric types are suppressed or a mixture of suppressed and missing then the calculated value will be marked as suppressed. If any of the values are marked as missing then the calculated value will show as missing. Not applicable values are ignored. Comments will not be included.",
"fields": [
{
"label": "Area type to aggregate from",
"identifier": "Area_Type_To_Aggregate",
"description": "Area type from which other areas are aggregated",
"lookupTable": "GeoAreaLevel",
"lookupId": "ID",
"lookupDisplay": "Identifier"
},
{
"label": "Rank metric type",
"identifier": "Rank_Metric_Type",
"description": "Metric type for rank which will be reversed"
},
{
"label": "Weighted by",
"identifier": "Weighted_By",
"description": "Metric type by which values are weighted"
},
{
"label": "Area type to exclude",
"identifier": "Area_Type_To_Exclude",
"description": "Area type to exclude from aggregation",
"lookupTable": "GeoAreaLevel",
"lookupId": "ID",
"lookupDisplay": "Identifier"
}
]
},
{
"identifier": "23",
"label": "Percentage of metric types below a decile",
"description": "Percentage of metric types equal to or below a set decile value. Aggregated up from a selected area type. If any of the metric types are suppressed or a mixture of suppressed and missing then the calculated value will be marked as suppressed. If any of the values are marked as missing then the calculated value will show as missing. Not applicable values are ignored. Comments will not be included.",
"fields": [
{
"label": "Area type to aggregate from",
"identifier": "Area_Type_To_Aggregate",
"description": "Area type from which other areas are aggregated",
"lookupTable": "GeoAreaLevel",
"lookupId": "ID",
"lookupDisplay": "Identifier"
},
{
"label": "Metric type",
"identifier": "Metric_Type",
"description": "Metric type from which values will be aggregated"
},
{
"label": "Threshold value",
"identifier": "Threshold",
"description": "Any decile the same as or less than this value will be counted"
},
{
"label": "Area type to exclude",
"identifier": "Area_Type_To_Exclude",
"description": "Area type to exclude from aggregation",
"lookupTable": "GeoAreaLevel",
"lookupId": "ID",
"lookupDisplay": "Identifier"
}
]
},
{
"identifier": "24",
"label": "Virtual metric type",
"description": "Values are calculated by web services, rather than in advance. Numerator metric types are calculated, then if applicable divided by denominator metric types, and if applicable, multiplied by the multiple.",
"fields": [
{
"label": "Numerator(s)",
"identifier": "Numerator",
"description": "Numerator (or if no denominator, just calculation) for one or many metric types"
},
{
"label": "Denominator(s)",
"identifier": "Denominator",
"description": "Denominator calculation for one or many metric types"
},
{
"label": "Multiple",
"identifier": "Multiple",
"description": "Multiple for the calculation"
}
]
},
{
"identifier": "25",
"label": "Average weekday per period",
"description": "Average value for the number of times the selected week day appears for the selected metric type in the current metric type's period.",
"fields": [
{
"label": "Metric type",
"identifier": "Metric_Type",
"description": "Metric type with days of week data"
},
{
"label": "Week day",
"identifier": "Week_Day",
"description": "Week day to be counted",
"lookupTable": "WeekdayList",
"lookupId": "ID",
"lookupDisplay": "Label"
}
]
},
{
"identifier": "26",
"label": "Average per period",
"description": "Average for the selected metric type over the current metric type's time period",
"fields": [
{
"label": "Metric type",
"identifier": "Metric_Type",
"description": "Metric type whose values will be averaged"
}
]
},
{
"identifier": "27",
"label": "Average per selected periods",
"description": "Average for the selected metric type over the selected number of previous time periods",
"fields": [
{
"label": "Metric type",
"identifier": "Metric_Type",
"description": "Metric type to be averaged"
},
{
"label": "Periods",
"identifier": "Periods",
"description": "Number of periods for the average"
}
]
},
{
"identifier": "28",
"label": "Median value",
"description": "From a particular measure and dimension generate the median value",
"fields": [
{
"label": "Measure",
"identifier": "Measure",
"description": "Identifier for the measure from which the average will be generated",
"lookupTable": "Measure",
"lookupId": "Id",
"lookupDisplay": "Identifier"
},
{
"label": "Circumstance",
"identifier": "Circumstance",
"description": "Identifier for the circumstance in the measure from which the average will be generated",
"lookupTable": "Dimension",
"lookupId": "Id",
"lookupDisplay": "Identifier"
}
]
}
]}