Skip to content

Commit

Permalink
Add skeleton for content
Browse files Browse the repository at this point in the history
  • Loading branch information
andrjohns committed Dec 11, 2023
1 parent 64f5e59 commit 714cea4
Show file tree
Hide file tree
Showing 18 changed files with 360 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/PatternDetection.md
Original file line number Diff line number Diff line change
@@ -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).
8 changes: 8 additions & 0 deletions docs/PatternDetection/astPoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Astronomical Point
layout: page
parent: Pattern Detection
nav_order: 4.1
---

# Astronomical Points
8 changes: 8 additions & 0 deletions docs/PatternDetection/shift.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Shift
layout: page
parent: Pattern Detection
nav_order: 4.3
---

# Shifts
8 changes: 8 additions & 0 deletions docs/PatternDetection/trend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Trend
layout: page
parent: Pattern Detection
nav_order: 4.2
---

# Trends
8 changes: 8 additions & 0 deletions docs/PatternDetection/twoInThree.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Two-In-Three
layout: page
parent: Pattern Detection
nav_order: 4.4
---

# Two-In-Three
10 changes: 10 additions & 0 deletions docs/PlotTheDots.md
Original file line number Diff line number Diff line change
@@ -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.
14 changes: 14 additions & 0 deletions docs/PlotTheDots/assurance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Assurance
layout: page
parent: Plot The Dots
nav_order: 6.2
---

# Assurance Types

## Inconsistent

## Consistent Pass

## Consistent Fail
14 changes: 14 additions & 0 deletions docs/PlotTheDots/variation.md
Original file line number Diff line number Diff line change
@@ -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
10 changes: 10 additions & 0 deletions docs/SettingsReference.md
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 16 additions & 0 deletions docs/SettingsReference/canvasSettings.md
Original file line number Diff line number Diff line change
@@ -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):
26 changes: 26 additions & 0 deletions docs/SettingsReference/dataSettings.md
Original file line number Diff line number Diff line change
@@ -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:
18 changes: 18 additions & 0 deletions docs/SettingsReference/dateFormat.md
Original file line number Diff line number Diff line change
@@ -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
38 changes: 38 additions & 0 deletions docs/SettingsReference/lineSettings.md
Original file line number Diff line number Diff line change
@@ -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
22 changes: 22 additions & 0 deletions docs/SettingsReference/nhsIcons.md
Original file line number Diff line number Diff line change
@@ -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
58 changes: 58 additions & 0 deletions docs/SettingsReference/outlierHighlighting.md
Original file line number Diff line number Diff line change
@@ -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
16 changes: 16 additions & 0 deletions docs/SettingsReference/scatterSettings.md
Original file line number Diff line number Diff line change
@@ -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
38 changes: 38 additions & 0 deletions docs/SettingsReference/xAxisSettings.md
Original file line number Diff line number Diff line change
@@ -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
38 changes: 38 additions & 0 deletions docs/SettingsReference/yAxisSettings.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 714cea4

Please sign in to comment.