2020-10-27 00:21:24 +03:00
# wpa <img src="man/figures/logo2.png" align="right" width=15% />
2020-11-17 13:07:09 +03:00
[![R build status ](https://github.com/microsoft/wpa/workflows/R-CMD-check/badge.svg )](https://github.com/microsoft/wpa/actions) [![CodeFactor ](https://www.codefactor.io/repository/github/microsoft/wpa/badge )](https://www.codefactor.io/repository/github/microsoft/wpa) [![License: MIT ](https://img.shields.io/badge/License-MIT-yellow.svg )](https://opensource.org/licenses/MIT) [![lifecycle ](https://img.shields.io/badge/lifecycle-maturing-blue.svg )](https://www.tidyverse.org/lifecycle/#maturing)
2020-10-27 00:21:24 +03:00
## Analyze and Visualize Workplace Analytics data
2020-11-16 15:13:18 +03:00
This is an R package for analyzing and visualizing data from [Microsoft Workplace Analytics ](https://www.microsoft.com/microsoft-365/partners/workplaceanalytics ).
2020-10-27 00:21:24 +03:00
2020-11-16 15:13:18 +03:00
## With the **wpa** package, you can...
2020-10-27 00:21:24 +03:00
2020-11-16 15:13:18 +03:00
1. **Run prebuilt analysis and visualizations** off Workplace Analytics data with settings for HR variables, privacy threshold, etc.
2020-11-25 17:11:28 +03:00
2020-11-16 15:13:18 +03:00
2. **Generate prebuilt interactive HTML reports** , which cover specific areas e.g. collaboration, connectivity
2020-11-25 17:11:28 +03:00
2020-11-16 15:13:18 +03:00
3. Leverage **advanced analytics functions** , such as text mining and hierarchical clustering, which are built for Workplace Analytics metrics
2020-11-25 17:11:28 +03:00
2020-11-16 15:13:18 +03:00
4. Integrate analysis of Workplace Analytics data with your R workflow seamlessly
2020-10-27 00:21:24 +03:00
2020-11-23 20:09:22 +03:00
Here is an example of **wpa** in action:
2020-11-16 17:13:30 +03:00
2020-11-23 20:09:22 +03:00
< img src = "man/figures/output2.gif" align = "center" width = 80% / >
2020-10-27 00:21:24 +03:00
2020-11-17 12:57:03 +03:00
---
2020-11-16 17:32:59 +03:00
2020-10-27 00:21:24 +03:00
## :rocket: Quick start guide - For users
2020-11-18 01:30:32 +03:00
### Installing the package
2020-10-27 00:21:24 +03:00
2020-11-18 01:30:32 +03:00
You can install the GitHub version of **wpa** with the following in R:
2020-11-16 15:13:18 +03:00
```R
2020-11-16 13:06:55 +03:00
# Check if devtools is installed, if not then install it
if(!"devtools" %in% installed.packages()){
install.packages("devtools")
}
devtools::install_git(url = "https://github.com/microsoft/wpa.git")
2020-10-27 00:21:24 +03:00
```
2020-11-18 01:30:32 +03:00
Note that **wpa** is not yet released on CRAN, and therefore `install.packages()` will not work.
2020-10-27 00:21:24 +03:00
### Examples
2020-11-16 15:13:18 +03:00
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):
2020-10-27 00:21:24 +03:00
```R
collaboration_sum(sq_data, return = "plot")
```
2020-11-25 17:11:28 +03:00
< img src = "https://raw.githubusercontent.com/microsoft/wpa/main/.github/gallery/collab_sum.png" align = "center" width = 80% / >
2020-10-27 00:21:24 +03:00
By passing 'table' to the `return` argument, the function will return a data frame with the relevant summary statistics.
2020-11-19 17:11:23 +03:00
The following illustrates the basic API of standard analysis functions:
< img src = "man/figures/api-demo.png" align = "center" width = 80% / >
2020-10-27 00:21:24 +03:00
---
2020-11-16 15:13:18 +03:00
## :package: Package Structure
2020-11-18 01:34:46 +03:00
For information on the package structure, please see the relevant section in our [Analyst Guide ](.github/analyst_guide.md ).
2020-11-16 15:13:18 +03:00
2020-11-17 17:57:16 +03:00
Also check out our package cheat sheet for more information:
2020-11-16 17:32:59 +03:00
2020-11-23 20:09:22 +03:00
< a href = "https://github.com/microsoft/wpa/blob/main/man/figures/wpa%20cheatsheet_20201116.pdf" > < img src = "https://raw.githubusercontent.com/microsoft/wpa/main/man/figures/wpa%20cheatsheet_20201116.png" align = "center" width = 50% / > < / a >
2020-11-16 15:30:48 +03:00
2020-11-16 15:13:18 +03:00
---
2020-10-27 00:21:24 +03:00
## Vignette
You can browse the vignette by running the following in R:
```R
vignette(topic = "intro-to-wpa", package = "wpa")
```
2020-11-16 15:30:48 +03:00
---
2020-10-27 00:21:24 +03:00
2020-11-16 15:30:48 +03:00
## :hammer: Developers
2020-11-11 00:04:45 +03:00
2020-11-16 15:30:48 +03:00
We welcome contributions to the package!
2020-11-11 00:04:45 +03:00
2020-11-16 15:30:48 +03:00
### Contributing code
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.
2020-11-11 00:04:45 +03:00
2020-11-16 15:30:48 +03:00
### Issues or Feature Requests
If you would like to log an issue or submit a feature request, please create a new issue or comment on an existing issue on [GitHub Issues ](https://github.com/microsoft/wpa/issues ) on this repo.
2020-11-11 00:04:45 +03:00
2020-11-16 15:30:48 +03:00
### Reporting Security Issues
Please do not report security vulnerabilities through public GitHub issues. Please read our Security document [for more details ](.github/reporting_security_issues.md ).
2020-11-11 00:04:45 +03:00
2020-11-17 12:57:03 +03:00
### Changelog
See [NEWS.md ](NEWS.md ) for the package changelog.
2020-11-11 00:04:45 +03:00
2020-11-17 12:57:03 +03:00
---
2020-11-11 00:04:45 +03:00
2020-11-16 15:30:48 +03:00
## Code of Conduct
2020-11-11 00:04:45 +03:00
2020-11-16 15:30:48 +03:00
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.
2020-11-11 00:04:45 +03:00
2020-11-16 15:30:48 +03:00
**Trademarks**
2020-11-11 00:04:45 +03:00
2020-11-17 01:26:54 +03:00
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.
2020-11-25 17:11:28 +03:00
---
2020-11-25 17:49:09 +03:00
## Finding this project useful?
:star: Please star this repository to keep us going!
Contributors to the GitHub repo:
2020-11-25 19:54:12 +03:00
![](https://raw.githubusercontent.com/microsoft/wpa/main/CONTRIBUTORS.svg)
2020-11-25 17:49:09 +03:00
See full list [here ](https://microsoft.github.io/wpa/authors.html ).