Merge pull request #166 from microsoft/release/v1.6.0

Release: CRAN Submission Changes for v1.6.0

.Rbuildignore

@@ -22,6 +22,7 @@ man-roxygen
 ^vignettes/Change-over-time.Rmd$
 ^vignettes/IV-report.Rmd$
 ^vignettes/text-mining-capabilities.Rmd$
+^vignettes/profiles-with-rank.Rmd$
 ^Meta$
 ^cran-comments\.md$
 ^CRAN-RELEASE$

.github/faq.md

@@ -23,7 +23,7 @@ remotes::install_github(repo = "microsoft/wpa", upgrade = "never")
 If the above does not work, please also try:
 
 ```R
-remotes::install_github(repo = "microsoft/wpa", upgrade = "never")
+remotes::install_git(url = "https://github.com/microsoft/wpa.git", upgrade = "never")
 ```
 
 For more information regarding installation, please see our [Getting Started](https://microsoft.github.io/wpa/analyst_guide_getting_started.html) page.

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: wpa
 Type: Package
 Title: Tools for Analysing and Visualising Workplace Analytics Data
-Version: 1.5.0.9000
+Version: 1.6.0
 Authors@R: c(
     person(given = "Martin", family = "Chan", role = c("aut", "cre"), email = "[email protected]"),
     person(given = "Carlos", family = "Morales", role = "aut", email = "[email protected]"),

NEWS.md

@@ -1,4 +1,4 @@
-# wpa (development version)
+# wpa 1.6.0
 
 - Improved visuals on `workpatterns_rank()` and `identify_shifts_wp()` (#160)
 - Added ability to show percentages on `identify_shifts_wp()` (#160)

R/anonymise.R

@@ -26,12 +26,12 @@
 #' rep <- c("Manager+", "Manager", "IC")
 #' unique(anonymise(sq_data$Layer), replacement = rep)
 #'
+#' @seealso jitter
 #' @export
 
 anonymise <- function(x,
                       scramble = FALSE,
-                      replacement = NULL,
-                      jitter = NULL){
+                      replacement = NULL){
 
   n_to_rep <- length(x)
   v_to_rep <- unique(x)
@@ -87,6 +87,7 @@ anonymize <- anonymise
 #'   )
 #' )
 #'
+#' @seealso anonymise
 #' @export
 
 jitter_metrics <- function(data, cols = NULL, ...){

R/create_rank.R

@@ -43,9 +43,12 @@
 #' @family Flexible
 #'
 #' @examples
+# Use a small sample for faster runtime
+#' sq_data_small <- dplyr::slice_sample(sq_data, prop = 0.1)
+#'
 #' # Plot mode 1 - show top and bottom five groups
 #' create_rank(
-#'   data = sq_data,
+#'   data = sq_data_small,
 #'   hrvar = c("FunctionType", "LevelDesignation"),
 #'   metric = "Emails_sent",
 #'   return = "plot",
@@ -54,7 +57,7 @@
 #'
 #' # Plot mode 2 - show top and bottom groups per HR variable
 #' create_rank(
-#'   data = sq_data,
+#'   data = sq_data_small,
 #'   hrvar = c("FunctionType", "LevelDesignation"),
 #'   metric = "Emails_sent",
 #'   return = "plot",
@@ -63,18 +66,20 @@
 #'
 #' # Return a table
 #' create_rank(
-#'   data = sq_data,
+#'   data = sq_data_small,
 #'   metric = "Emails_sent",
 #'   return = "table"
 #' )
 #'
+#' \donttest{
 #' # Return a table - combination mode
 #' create_rank(
-#'   data = sq_data,
+#'   data = sq_data_small,
 #'   metric = "Emails_sent",
 #'   mode = "combine",
 #'   return = "table"
 #' )
+#' }
 #'
 #' @return
 #' A different output is returned depending on the value passed to the `return`
@@ -277,8 +282,11 @@ create_rank <- function(data,
 #' @inheritParams create_rank
 #'
 #' @examples
+#' # Use a small sample for faster runtime
+#' sq_data_small <- dplyr::slice_sample(sq_data, prop = 0.1)
+#'
 #' create_rank_combine(
-#'   data = sq_data,
+#'   data = sq_data_small,
 #'   metric = "Email_hours"
 #' )
 #'

R/track_hr_change.R

@@ -8,12 +8,13 @@
 #'
 #' @description
 #' Creates a list of everyone at a specified start date and a specified end date
-#' then aggregates up people who have moved between orgs between this to points
-#' of time and visualizes the move through a sankey chart.
+#' then aggregates up people who have moved between organizations between this
+#' to points of time and visualizes the move through a sankey chart.
+#'
 #' Through this chart you can see:
 #' -  The HR attribute/orgs that have the highest move out
 #' -  The HR attribute/orgs that have the highest move in
-#' -  The number of people that do not have that HR attribute ot  they are no
+#' -  The number of people that do not have that HR attribute or if they are no
 #' longer in the system
 #'
 #' @author Tannaz Sattari Tabrizi <Tannaz.Sattari@@microsoft.com>

README.md

@@ -4,8 +4,8 @@
   [![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://lifecycle.r-lib.org/articles/stages.html)
-  [![CRAN status](https://www.r-pkg.org/badges/version/wpa)](https://CRAN.R-project.org/package=wpa)
-  [![CRAN last month downloads](http://cranlogs.r-pkg.org/badges/last-month/wpa?color=green)](https://cran.r-project.org/package=wpa)
+  [![CRAN status](https://www.r-pkg.org/badges/version/wpa/)](https://CRAN.R-project.org/package=wpa/)
+  [![CRAN last month downloads](https://cranlogs.r-pkg.org/badges/last-month/wpa?color=green/)](https://cran.r-project.org/package=wpa/)
 
 ## Analyze and Visualize Workplace Analytics data
 
@@ -51,7 +51,7 @@ We welcome contributions to the package!
 If you would like contribute code to the repo, please read our [Contributor Guide](https://microsoft.github.io/wpa/CONTRIBUTING.html) and [Developer Guide](https://microsoft.github.io/wpa/developer_guide.html). This documentation should provide you all the information you will need to get started.
 
 ### 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.
+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.
 
 ### Reporting Security Issues
 Please do not report security vulnerabilities through public GitHub issues. Please read our Security document [for more details](https://microsoft.github.io/wpa/reporting_security_issues.html).
@@ -68,7 +68,7 @@ We would ask you to please read the [Microsoft Open Source Code of Conduct](http
 
 **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.
+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/). 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.
 
 ---
 

cran-comments.md

@@ -1,6 +1,6 @@
 ## Test environments
-* local R installation, R 3.6.3
-* ubuntu 16.04 (on travis-ci), R 3.6.3
+* local R installation, R 4.0.5
+* ubuntu 16.04 (on travis-ci), R 4.0.5
 * win-builder (devel)
 
 ## R CMD check results
@@ -9,6 +9,10 @@
 
 * This is a new release.
 
+## Submission 1.6.0
+
+Minor release implementing several features and fixing bugs logged on GitHub.
+
 ## Submission 1.5.0
 
 Minor release with improvements to visualization functions.