diff --git a/docs/PatternDetection.md b/docs/PatternDetection.md new file mode 100644 index 0000000..284c1b3 --- /dev/null +++ b/docs/PatternDetection.md @@ -0,0 +1,10 @@ +--- +title: Pattern Detection +layout: page +has_children: true +nav_order: 4 +--- + +# Pattern/Outlier Detection + +This page summarises the available outlier/pattern detection algorithms. For any others that you'd like to see added, please open an issue on the [GitHub page](https://github.com/AUS-DOH-Safety-and-Quality/PowerBI-SPC). diff --git a/docs/PatternDetection/astPoint.md b/docs/PatternDetection/astPoint.md new file mode 100644 index 0000000..096e653 --- /dev/null +++ b/docs/PatternDetection/astPoint.md @@ -0,0 +1,8 @@ +--- +title: Astronomical Point +layout: page +parent: Pattern Detection +nav_order: 4.1 +--- + +# Astronomical Points diff --git a/docs/PatternDetection/shift.md b/docs/PatternDetection/shift.md new file mode 100644 index 0000000..89afcfe --- /dev/null +++ b/docs/PatternDetection/shift.md @@ -0,0 +1,8 @@ +--- +title: Shift +layout: page +parent: Pattern Detection +nav_order: 4.3 +--- + +# Shifts diff --git a/docs/PatternDetection/trend.md b/docs/PatternDetection/trend.md new file mode 100644 index 0000000..969fa41 --- /dev/null +++ b/docs/PatternDetection/trend.md @@ -0,0 +1,8 @@ +--- +title: Trend +layout: page +parent: Pattern Detection +nav_order: 4.2 +--- + +# Trends diff --git a/docs/PatternDetection/twoInThree.md b/docs/PatternDetection/twoInThree.md new file mode 100644 index 0000000..7758b5b --- /dev/null +++ b/docs/PatternDetection/twoInThree.md @@ -0,0 +1,8 @@ +--- +title: Two-In-Three +layout: page +parent: Pattern Detection +nav_order: 4.4 +--- + +# Two-In-Three diff --git a/docs/PlotTheDots.md b/docs/PlotTheDots.md new file mode 100644 index 0000000..60ef64e --- /dev/null +++ b/docs/PlotTheDots.md @@ -0,0 +1,10 @@ +--- +title: Plot The Dots +layout: page +has_children: true +nav_order: 6 +--- + +# NHS Plot-The-Dots: Variation & Assurance + +This page summarises the usage of the NHS Variation & Assurance iconography with SPC charts. diff --git a/docs/PlotTheDots/assurance.md b/docs/PlotTheDots/assurance.md new file mode 100644 index 0000000..1c18486 --- /dev/null +++ b/docs/PlotTheDots/assurance.md @@ -0,0 +1,14 @@ +--- +title: Assurance +layout: page +parent: Plot The Dots +nav_order: 6.2 +--- + +# Assurance Types + +## Inconsistent + +## Consistent Pass + +## Consistent Fail diff --git a/docs/PlotTheDots/variation.md b/docs/PlotTheDots/variation.md new file mode 100644 index 0000000..ff4488a --- /dev/null +++ b/docs/PlotTheDots/variation.md @@ -0,0 +1,14 @@ +--- +title: Variation +layout: page +parent: Plot The Dots +nav_order: 6.1 +--- + +# Variation Types + +## Common Cause + +## Special Cause - Concern + +## Special Cause - Deterioration diff --git a/docs/SettingsReference.md b/docs/SettingsReference.md new file mode 100644 index 0000000..e74dece --- /dev/null +++ b/docs/SettingsReference.md @@ -0,0 +1,10 @@ +--- +title: Settings Reference +layout: page +has_children: true +nav_order: 7 +--- + +# Settings Options + +This page summarises the usage and options for each of the Settings menus provided by the visual. diff --git a/docs/SettingsReference/canvasSettings.md b/docs/SettingsReference/canvasSettings.md new file mode 100644 index 0000000..2fd58c7 --- /dev/null +++ b/docs/SettingsReference/canvasSettings.md @@ -0,0 +1,16 @@ +--- +title: Canvas Settings +layout: page +parent: Settings Reference +nav_order: 7.4 +--- + +# Plot Padding Configuration + +## Padding Below Plot (pixels): + +## Padding Above Plot (pixels): + +## Padding Left of Plot (pixels): + +## Padding Right of Plot (pixels): diff --git a/docs/SettingsReference/dataSettings.md b/docs/SettingsReference/dataSettings.md new file mode 100644 index 0000000..e40a0cb --- /dev/null +++ b/docs/SettingsReference/dataSettings.md @@ -0,0 +1,26 @@ +--- +title: Data Settings +layout: page +parent: Settings Reference +nav_order: 7.1 +--- + +# SPC Chart & Calculation Options + +## Chart Type + +## Keep Outliers in Limit Calcs. + +## Multiplier + +## Decimals to Report + +## Report as percentage + +## Split Limits on Click + +## Truncate Lower Limits at: + +## Truncate Upper Limits at: + +## Additional Target Value: diff --git a/docs/SettingsReference/dateFormat.md b/docs/SettingsReference/dateFormat.md new file mode 100644 index 0000000..f34436e --- /dev/null +++ b/docs/SettingsReference/dateFormat.md @@ -0,0 +1,18 @@ +--- +title: Date Format +layout: page +parent: Settings Reference +nav_order: 7.6 +--- + +# Date Formatting + +## Locale + +## Day Format + +## Month Format + +## Year Format + +## Delimiter diff --git a/docs/SettingsReference/lineSettings.md b/docs/SettingsReference/lineSettings.md new file mode 100644 index 0000000..82a8274 --- /dev/null +++ b/docs/SettingsReference/lineSettings.md @@ -0,0 +1,38 @@ +--- +title: Line Settings +layout: page +parent: Settings Reference +nav_order: 7.7 +--- + +# Line Plot Aesthetics + +## 99.8% Line Width + +## 95% Line Width + +## Main Line Width + +## Target Line Width + +## Alt. Target Line Width + +## 99.8% Line Type + +## 95% Line Type + +## Main Line Type + +## Target Line Type + +## Alt. Target Line Type + +## 99.8% Line Colour + +## 95% Line Colour + +## Main Line Colour + +## Target Line Colour + +## Alt. Target Line Colour diff --git a/docs/SettingsReference/nhsIcons.md b/docs/SettingsReference/nhsIcons.md new file mode 100644 index 0000000..871abdc --- /dev/null +++ b/docs/SettingsReference/nhsIcons.md @@ -0,0 +1,22 @@ +--- +title: NHS Icons +layout: page +parent: Settings Reference +nav_order: 7.3 +--- + +# NHS Iconography Options + +## Show Variation Icons + +## Flag Only Last Point + +## Variation Icon Locations + +## Scale Variation Icon Size + +## Show Assurance Icons + +## Assurance Icon Locations + +## Scale Assurance Icon Size diff --git a/docs/SettingsReference/outlierHighlighting.md b/docs/SettingsReference/outlierHighlighting.md new file mode 100644 index 0000000..1d19f20 --- /dev/null +++ b/docs/SettingsReference/outlierHighlighting.md @@ -0,0 +1,58 @@ +--- +title: Outlier Highlighting +layout: page +parent: Settings Reference +nav_order: 7.2 +--- + +# Pattern Detection Configuration & Aesthetics + +## Type of Change to Flag + +## Improvement Direction + +## Highlight all in Pattern + +## Astronomical Points + +### Imp. Ast. Colour + +### Det. Ast. Colour + +### Neutral (Low) Ast. Colour + +### Neutral (High) Ast. Colour + +## Shifts + +### Shift Points + +### Imp. Shift Colour + +### Det. Shift Colour + +### Neutral (Low) Shift Colour + +### Neutral (High) Shift Colour + +## Trends + +### Trend Points + +### Imp. Trend Colour + +### Det. Trend Colour + +### Neutral (Low) Trend Colour + +### Neutral (High) Trend Colour + +## Two-in-Three + +### Imp. Two-in-Three Colour + +### Det. Two-in-Three Colour + +### Neutral (Low) Two-in-Three Colour + +### Neutral (High) Two-in-Three Colour diff --git a/docs/SettingsReference/scatterSettings.md b/docs/SettingsReference/scatterSettings.md new file mode 100644 index 0000000..b499130 --- /dev/null +++ b/docs/SettingsReference/scatterSettings.md @@ -0,0 +1,16 @@ +--- +title: Scatter Settings +layout: page +parent: Settings Reference +nav_order: 7.5 +--- + +# Scatterplot Aesthetic Configuration + +## Dot Size + +## Opacity + +## Opacity if Unselected + +## Colour diff --git a/docs/SettingsReference/xAxisSettings.md b/docs/SettingsReference/xAxisSettings.md new file mode 100644 index 0000000..82a8274 --- /dev/null +++ b/docs/SettingsReference/xAxisSettings.md @@ -0,0 +1,38 @@ +--- +title: Line Settings +layout: page +parent: Settings Reference +nav_order: 7.7 +--- + +# Line Plot Aesthetics + +## 99.8% Line Width + +## 95% Line Width + +## Main Line Width + +## Target Line Width + +## Alt. Target Line Width + +## 99.8% Line Type + +## 95% Line Type + +## Main Line Type + +## Target Line Type + +## Alt. Target Line Type + +## 99.8% Line Colour + +## 95% Line Colour + +## Main Line Colour + +## Target Line Colour + +## Alt. Target Line Colour diff --git a/docs/SettingsReference/yAxisSettings.md b/docs/SettingsReference/yAxisSettings.md new file mode 100644 index 0000000..b8b6535 --- /dev/null +++ b/docs/SettingsReference/yAxisSettings.md @@ -0,0 +1,38 @@ +--- +title: Y-Axis Settings +layout: page +parent: Settings Reference +nav_order: 7.9 +--- + +# Y-Axis Aesthetics + +## Axis Colour + +## Draw Ticks + +## Tick Decimal Places + +## Tick Font + +## Tick Font Size + +## Tick Font Colour + +## Tick Rotation (Degrees) + +## Maximum Ticks + +## Label + +## Label Font + +## Label Font Size + +## Label Font Colour + +## Axis Scaling Factor + +## Lower Limit + +## Upper Limit