From 20dce3f8578f8af868d2cbb253c91f940ef402ce Mon Sep 17 00:00:00 2001 From: Andrew Johnson Date: Thu, 7 Dec 2023 13:36:35 +0200 Subject: [PATCH] Test index md --- index.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 index.md diff --git a/index.md b/index.md new file mode 100644 index 0000000..c69283b --- /dev/null +++ b/index.md @@ -0,0 +1,57 @@ +# Introduction +This repository contains a free PowerBI custom visual for you to create Statistical Process Control (SPC) charts. This page is a short guide on how to download and install it. It has been developed by the Safety and Quality team at the West Australian Health Department's Healthcare Quality Intelligence Unit. If you'd like more detail on SPC we recommend the [NHS Making Data Count guide]([url](https://www.england.nhs.uk/publication/making-data-count/)). + +The visual is implemented purely within PowerBI and has no dependencies on external programs like R or Python. The visual supports hover-over-tooltips as well as cross-plot filtering and highlighting. + +The following chart types are (currently) available: + + - Run: Run Chart + - i: Individual Measurements (also known as XmR) + - mr: Moving Range of Individual Measurements + - p: Proportions + - p': Proportions with Large-Sample Correction + - u: Rates + - u': Rates with Large-Sample Correction + - c: Counts + - xbar: Sample Means + - s: Sample SDs + - g: Number of Non-events Between Events + - t: Time Between Events + + + +# Installing the Visual + +You can download the most recent version from the ['Releases' section](https://github.com/AUS-DOH-Safety-and-Quality/PowerBI-SPC/releases/tag/latest). Save the file to your desktop. Within Power BI, use the Visuals pane and add using the 'Import visual from a file' option: + +![image](https://user-images.githubusercontent.com/27717896/128833977-51ae139d-43f2-4d32-8c8c-4cdcabc2bdaf.png) + +Find the file on your desktop and click OK. The custom visual will show as a new icon. + +# Using the Visual + +Once you have installed the visual and added it to your report, you can add the desired data (numerators, denominators, and dates) to the visual: + +![image](https://user-images.githubusercontent.com/27717896/177291124-2215ff5b-d81c-4195-a948-e6fa2d20a544.png) + +The visual will default to displaying an i-Chart: + +![image](https://user-images.githubusercontent.com/27717896/177291187-a8d8b875-e083-4d49-93f8-b4fbcdf4eebb.png) + +You can change this through the 'Data Settings' menu: + +![image](https://user-images.githubusercontent.com/27717896/177291297-35346801-d049-4c05-86c1-41ee5cc51f9d.png) + +Aesthetic options for the lines, scatter dots, and chart axes are also available. + +# (Advanced) Building Locally + +You won't need to do this step if you have installed the visual using the steps above. However, if you have strong IT skills and you'd like to build the PowerBI visual locally, (.pbiviz file), you will need a working Node.js installation and internet access. After that, navigate to the project source directory and run: +``` +npm install +npm install -g powerbi-visuals-tools +pbiviz package +``` + +Thiw will create the visual for you. The .pbiviz file can then be found in the `dist` directory +