docs: add function types to README

README.md

@@ -4,7 +4,7 @@
 
 ## Analyze and Visualize Workplace Analytics data
 
-This is an R package for analyzing and visualizing data from Microsoft Workplace Analytics.
+This is an R package for analyzing and visualizing data from [Microsoft Workplace Analytics](https://www.microsoft.com/microsoft-365/partners/workplaceanalytics).
 
 ## Design Principles
 
@@ -12,13 +12,14 @@ This is an R package for analyzing and visualizing data from Microsoft Workplace
 - **Practical**: the functions should prioritise delivering against the most frequently used outputs and analyses.
 - **Consistency**: functions should share a broadly consistent set of input arguments and naming conventions. This will help minimise unexpected results and errors when using the package. 
 - **Parsimony**: in creating the package, as much of the existing code should be re-used if possible to minimise duplication of work and to make analysis reproducible.
-- **Tidy**: the functions from the package are designed to be consistent with tidy principles, and work well with a {dplyr} pipe workflow.
+- **Tidy**: the functions from the package are designed to be consistent with tidy principles, and work well with a **dplyr** pipe (`%>%`) workflow.
 
-## What you can do with this package
+## With the **wpa** package, you can...
 
-- Run analysis and visualisations off WpA data with prebuilt settings for HR variables, privacy threshold, etc.
-- Create pre-designed ggplot visualisations that can be further customised, or inserted straight into your analysis flow as required
-- Generate interactive HTML reports that summarise a dimension of your WpA data, such as **collaboration**. 
+1. **Run prebuilt analysis and visualizations** off Workplace Analytics data with settings for HR variables, privacy threshold, etc.
+2. **Generate prebuilt interactive HTML reports**, which cover specific areas e.g. collaboration, connectivity 
+3. Leverage **advanced analytics functions**, such as text mining and hierarchical clustering, which are built for Workplace Analytics metrics
+4. Integrate analysis of Workplace Analytics data with your R workflow seamlessly
 
 <img src="man/figures/output.gif" align="center" width=80% />
 
@@ -27,7 +28,7 @@ This is an R package for analyzing and visualizing data from Microsoft Workplace
 ### Installing the package from GitHub
 
 You can install **wpa** from GitHub with the following: 
-```
+```R
 # Check if devtools is installed, if not then install it
 if(!"devtools" %in% installed.packages()){
   install.packages("devtools")
@@ -36,7 +37,7 @@ devtools::install_git(url = "https://github.com/microsoft/wpa.git")
 ```
 ### Examples
 
-The package comes shipped with a Standard Query dataset (`sq_data`), so you can start exploring functions without having to read in any data. Most functions in {wpa} share a consistent API, and enable you to return results for both a **plot** or a **table** (data frame):
+The package comes shipped with a sample Standard Query dataset (`sq_data`), so you can start exploring functions without having to read in any data. Most functions in **wpa** share a consistent API, and enable you to return results for both a **plot** or a **table** (data frame):
 
 ```R
 collaboration_sum(sq_data, return = "plot")
@@ -52,6 +53,46 @@ We welcome contributions to the package! If you would like contribute code to th
 
 ---
 
+## :package: Package Structure
+
+There are three main types of functions in **wpa**:
+1. Standard Analysis 
+2. Report Generation
+3. Advanced / Support Functions
+
+### 1. Standard Analysis
+
+**Standard Analysis** functions are the most common type of functions in **wpa**. They typically accept a data frame as an input (usually requiring a Standard Person Query), and can return either a pre-designed graph as a ggplot object, or a summary data table as a data frame. 
+
+Examples:
+- `collaboration_dist()`
+- `meeting_summary()`
+- `email_trend()`
+- `mgrrel_matrix()`
+
+### 2. Report Generation
+**Report Generation** functions are a special class of functions within **wpa** which outputs an interactive HTML report on a specific area based on the data you supply. 
+
+**Examples:**
+
+- `collaboration_report()`
+- `capacity_report()`
+- `coaching_report()`
+- `connectivity_report()`
+- `meeting_tm_report()`
+- `validation_report()`
+
+### 3. Advanced / support functions
+This final group consists of miscellaneous functions which either perform a specific piece of analysis (e.g. computing the Information Value score), or are designed to be used with Standard Analysis functions. 
+
+A significant example of this is `export()`, which you can use with a Standard Analysis function to:
+
+- Copy a data frame to clipboard (which can be pasted into Excel)
+- Save the generated plot as a PNG or a SVG image file
+- Save the data frame to a CSV file
+
+---
+
 ## Vignette
 
 You can browse the vignette by running the following in R: