This is an R package for analyzing and visualizing data from Microsoft Workplace Analytics.
## Design Principles
- **Simple**: the functions ought to be simple and intuitive, to maximise adoption.
- **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.
## What you can do with this package
- 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**.
Click the green 'Clone or download' button on this repository, and save the package in a directory of your choice. It doesn't matter where you save this, as the installation process will install the package together with the rest of R packages.
If you have GitHub Desktop installed, simply click 'Open in Desktop' and follow the instructions to save the repository into a local directory.
### How to install the package from local directory - method #1
1. Either open the RProject file in the directory of the {wpa} package (the one titled _wpa.Rproj_), or navigate to it within R using `setwd()` by providing an absolute filepath. For instance, if you've downloaded the package to _C:/Users/Documents/wpa_, you'd need to run:
```R
setwd("C:/Users/Documents/wpa")
```
This step is the same regardless of whether you manually cloned the repository or did this via GitHub Desktop.
2. Make sure you have the package {devtools} installed. If you don't or unsure whether you do, run:
```R
install.packages("devtools")
```
Once that's done, run `devtools::install()`. You may be asked to update your packages, which is optional for the installation. We recommend just entering a blank line for a quick installation.
3. Once the {wpa} package is installed, you can load the package by running:
```R
library(wpa)
```
### How to install the package from local directory - with a tarball via RStudio
This is a method to install the package with a tarball release.
1. Download the latest version of {wpa} to your desktop (make sure it has the ".tar.gz" extension).
2. Open RStudio.
3. Click on the Packages tab in the bottom right window.
4. Click "Install."
5. Select install from "Package Archive File."
6. Select the {wpa} package file from your desktop.
7. Click install.
8. Load the library with the command `library(wpa)`.
### 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):
We welcome contributions to the package! If you would like contribute code to the repo, please read our [Contributor Guide](CONTRIBUTING.md) and [Developer Guide](.github/developer_guide.md). This documentation should provide you all the information you will need to get started.
You can browse the vignette by running the following in R:
```R
vignette(topic = "intro-to-wpa", package = "wpa")
```
---
## Code of Conduct
We would ask you to please read the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct) prior to engaging with this package.
**Trademarks**
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
## Reporting Security Issues
**Please do not report security vulnerabilities through public GitHub issues.**
Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
* Full paths of source file(s) related to the manifestation of the issue
* The location of the affected source code (tag/branch/commit or direct URL)
* Any special configuration required to reproduce the issue
* Step-by-step instructions to reproduce the issue
* Proof-of-concept or exploit code (if possible)
* Impact of the issue, including how an attacker might exploit the issue
This information will help us triage your report more quickly.
If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs.
## Preferred Languages
We prefer all communications to be in English.
## Policy
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
