Merge pull request #228 from microsoft/refactor/streamline-network_p2p

Merging - `v1.9.0` has been accepted and is on its way to CRAN.

Author: martinctc

.Rbuildignore

@@ -14,6 +14,7 @@
 ^\.github$
 ^CONTRIBUTORS.svg$
 man-roxygen
+lastMiKTeXException
 
 # Ignore all figures
 ^man/figures

.github/workflows/R-CMD-check.yaml

@@ -6,7 +6,7 @@ jobs:
   R-CMD-check:
     runs-on: macOS-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: r-lib/actions/setup-r@v2-branch
       - name: Install dependencies
         run: |
@@ -17,4 +17,4 @@ jobs:
         env:
           _R_CHECK_FORCE_SUGGESTS_: true
         run: rcmdcheck::rcmdcheck(args = "--no-manual", error_on = "error")
-        shell: Rscript {0}
+        shell: Rscript {0}

CRAN-SUBMISSION

@@ -1,3 +1,3 @@
-Version: 1.8.1
-Date: 2023-01-27 11:02:41 UTC
-SHA: da6fe2da817d04f06e90017f92f82cb788d093df
+Version: 1.9.0
+Date: 2023-08-21 13:44:41 UTC
+SHA: f562f477da8f7fcc2311aa6a860badb1cf042b91

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: wpa
 Type: Package
 Title: Tools for Analysing and Visualising Viva Insights Data
-Version: 1.8.1
+Version: 1.9.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]"),
@@ -56,12 +56,11 @@ Imports:
     ggwordcloud,
     methods,
     data.table
-RoxygenNote: 7.2.0
+RoxygenNote: 7.2.3
 Roxygen: list(markdown = TRUE)
 Suggests: 
     knitr,
     extrafont,
-    leiden,
     lifecycle,
     fst,
     glue,

NAMESPACE

@@ -134,8 +134,6 @@ export(mgrcoatt_dist)
 export(mgrrel_matrix)
 export(network_describe)
 export(network_g2g)
-export(network_leiden)
-export(network_louvain)
 export(network_p2p)
 export(network_summary)
 export(one2one_dist)
@@ -193,7 +191,6 @@ export(workpatterns_rank)
 export(workpatterns_report)
 export(wrap)
 export(wrap_text)
-import(DT)
 import(dplyr)
 import(ggplot2)
 import(ggraph)
@@ -209,10 +206,6 @@ importFrom(data.table,rbindlist)
 importFrom(dplyr,`%>%`)
 importFrom(dplyr,across)
 importFrom(dplyr,mutate)
-importFrom(dplyr,mutate_if)
-importFrom(grDevices,rainbow)
-importFrom(graphics,legend)
-importFrom(graphics,par)
 importFrom(htmltools,HTML)
 importFrom(igraph,graph_from_data_frame)
 importFrom(magrittr,"%>%")

NEWS.md

@@ -1,3 +1,16 @@
+# wpa 1.9.0
+
+Updates to `network_p2p()`, with breaking changes to the argument, addressing issue #225:
+
+  - `network_p2p()` now has a `centrality` argument for computing and visualizing centrality as node sizes in the network plot
+  - the `algorithm` argument is renamed to `layout` for better intuitiveness
+  - Improved consistency and intuitiveness of the API, with `style` argument now controlling the network plotting mechanism and `return` argument controlling whether plots are generated interactively or saved as PDF
+  - Added a large number of community detection algorithms from `igraph`
+
+`network_summary()` adds the ability to return pagerank.
+
+This version also includes some minor dependency maintenance done to `create_dt()`.
+
 # wpa 1.8.1
 
 - fixed issue due to a 'tidyr' update (see #233).

R/IV_by_Period.R

@@ -40,15 +40,16 @@
 #' @family Time-series
 #'
 #' @examples
+#' \donttest{
 #' # Returns a data frame
 #' sq_data %>%
 #'   IV_by_period(
-#'     before_start = "2019-11-03",
-#'     before_end = "2019-11-09",
-#'     after_start = "2019-11-10",
-#'     after_end = "2019-11-16"
+#'     before_start = "2019-12-15",
+#'     before_end = "2019-12-29",
+#'     after_start = "2020-01-05",
+#'     after_end = "2020-01-26"
 #'   )
-#'
+#' }
 #' @export
 
 IV_by_period <-

R/collaboration_area.R

@@ -38,6 +38,7 @@
 #' @family Collaboration
 #'
 #' @examples
+#' \donttest{
 #' # Return plot with total (default)
 #' collaboration_area(sq_data)
 #'
@@ -46,6 +47,7 @@
 #'
 #' # Return summary table
 #' collaboration_area(sq_data, return = "table")
+#' }
 #'
 #' @return
 #' A different output is returned depending on the value passed to the `return` argument:

R/create_ITSA.R

@@ -64,13 +64,13 @@
 #'
 #'
 #' @examples
+#' \donttest{
 #' # Returns summary table
-#'
 #' create_ITSA(
 #'   data = sq_data,
-#'   before_start = "11/03/2019",
-#'   before_end = "12/15/2019",
-#'   after_start = "12/29/2019",
+#'   before_start = "12/15/2019",
+#'   before_end = "12/29/2019",
+#'   after_start = "1/5/2020",
 #'   after_end = "1/26/2020",
 #'   ac_lags_max = 7,
 #'   return = "table")
@@ -80,15 +80,16 @@
 #' plot_list <-
 #'   create_ITSA(
 #'     data = sq_data,
-#'     before_start = "11/03/2019",
-#'     before_end = "12/15/2019",
-#'     after_start = "12/29/2019",
+#'     before_start = "12/15/2019",
+#'     before_end = "12/29/2019",
+#'     after_start = "1/5/2020",
 #'     after_end = "1/26/2020",
 #'     ac_lags_max = 7,
 #'     return = 'plot')
 #'
 #' # Extract a plot as an example
 #' plot_list$Workweek_span
+#' }
 #'
 #' @export
 

R/create_IV.R

@@ -61,7 +61,7 @@
 #'
 #' # Return summary
 #' sq_data %>%
-#'   dplyr::mutate(X = ifelse(Collaboration_hours > 2, 1, 0)) %>%
+#'   dplyr::mutate(X = ifelse(Collaboration_hours > 10, 1, 0)) %>%
 #'   create_IV(outcome = "X",
 #'             predictors = c("Email_hours", "Meeting_hours"),
 #'             return = "summary")