6.3 KiB

Исходник Ответственный История

wpa

Analyze and Visualize Workplace Analytics data

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.

🚀 Quick start guide - For users

Installing the package from GitHub

You can install wpa from GitHub with the following:

# 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")

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):

collaboration_sum(sq_data, return = "plot")

By passing 'table' to the return argument, the function will return a data frame with the relevant summary statistics.

🔨 Developers

We welcome contributions to the package! If you would like contribute code to the repo, please read our Contributor Guide and Developer Guide. This documentation should provide you all the information you will need to get started.

Vignette

You can browse the vignette by running the following in 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 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. 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.

Security

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, Azure, DotNet, AspNet, Xamarin, and our GitHub organizations.

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, 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.

If you prefer to submit without logging in, send email to 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.

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.

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 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.

6.3 KiB Исходник Ответственный История

wpa