Merge pull request #87 from AstraZeneca/version_0_6_updates

Version 0.6 updates

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: maraca
-Version: 0.5.1
+Version: 0.6
 Type: Package
 Title: The Maraca Plot: Visualization of Hierarchical Composite Endpoints in Clinical Trials
 License: Apache License (>= 2)
@@ -19,14 +19,14 @@ BugReports: https://github.com/AstraZeneca/maraca/issues
 Encoding: UTF-8
 LazyData: true
 Depends:
-    R (>= 3.5)
+    R (>= 3.5),
+    hce (>= 0.5)
 Imports:
     dplyr (>= 1.0),
     tidyr (>= 1.2),
     ggplot2 (>= 3.3),
-    hce (>= 0.0.2),
     checkmate (>= 2.1)
-RoxygenNote: 7.2.1
+RoxygenNote: 7.2.3
 Suggests:
     knitr (>= 1.39),
     here (>= 1.0.1),

NAMESPACE

@@ -1,8 +1,13 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method(component_plot,default)
+S3method(component_plot,hce)
+S3method(component_plot,maraca)
 S3method(plot,hce)
 S3method(plot,maraca)
 S3method(print,maraca)
+export(component_plot)
 export(maraca)
 export(plot_maraca)
 export(validate_maraca_plot)
+import(hce)

NEWS.md

@@ -1,3 +1,22 @@
+# maraca 0.6
+
+## New features
+
+- The `theme` argument in the plotting functions allows users to easily change the
+  styling of the plot. Details are given in the new vignette
+  "Maraca Plots - Themes and Styling".
+- A new plot to visualize the win odds components was added. The `component_plot()`
+  function works for both `maraca` and `hce`. Details can be found in the new
+  vignette "Maraca Plots - Plotting win odds".
+- A new vignette called "Maraca Plots - Validation" to highlight the function
+  `validate_maraca()` that was added in version 0.5.
+
+## Dependency change
+
+- `maraca` now has increased the version dependency for the package `hce`
+  to >= 0.5.
+- The `hce` is now automatically attached when loading `maraca`.
+
 # maraca 0.5.1
 
 ## Bug fixes

R/aaa.R

@@ -1,5 +1,6 @@
 # Ignored NSE variables in devtools::check
 utils::globalVariables("time")
+utils::globalVariables("n")
 utils::globalVariables("n.event")
 utils::globalVariables("x")
 utils::globalVariables("y")
@@ -21,6 +22,8 @@ utils::globalVariables("treatments")
 utils::globalVariables("fixed_followup_days")
 utils::globalVariables("average")
 utils::globalVariables("value")
+utils::globalVariables("percentage")
+utils::globalVariables("name")
 utils::globalVariables(".env")
 utils::globalVariables("separation")
 utils::globalVariables("gap")
@@ -35,3 +38,12 @@ utils::globalVariables("xupper")
 utils::globalVariables("xmax")
 utils::globalVariables("xmax_final")
 utils::globalVariables("outliers")
+utils::globalVariables("GROUP")
+utils::globalVariables("TRTP")
+utils::globalVariables("WIN")
+utils::globalVariables("LOSS")
+utils::globalVariables("TIE")
+utils::globalVariables("TOTAL")
+utils::globalVariables("WIN_A")
+utils::globalVariables("WIN_P")
+utils::globalVariables("TIE_A")

R/general.R

@@ -2,6 +2,7 @@
 #'
 #' @docType package
 #' @name maraca
+#' @import hce
 #' @aliases maraca-package
 NULL
 
@@ -13,7 +14,6 @@ NULL
 #' @usage data(hce_scenario_a)
 #' @format A data frame with 1000 rows.
 #' \describe{
-#'   \item{X}{Row number}
 #'   \item{SUBJID}{The patient identifier}
 #'   \item{GROUP}{Which type of outcome the row belongs to}
 #'   \item{GROUPN}{Not required for computation.
@@ -35,7 +35,6 @@ NULL
 #' @usage data(hce_scenario_b)
 #' @format A data frame with 1000 rows.
 #' \describe{
-#'   \item{X}{Row number}
 #'   \item{SUBJID}{The patient identifier}
 #'   \item{GROUP}{Which type of outcome the row belongs to}
 #'   \item{GROUPN}{Not required for computation.
@@ -57,7 +56,6 @@ NULL
 #' @usage data(hce_scenario_c)
 #' @format A data frame with 1000 rows.
 #' \describe{
-#'   \item{X}{Row number}
 #'   \item{SUBJID}{The patient identifier}
 #'   \item{GROUP}{Which type of outcome the row belongs to}
 #'   \item{GROUPN}{Not required for computation.
@@ -79,7 +77,6 @@ NULL
 #' @usage data(hce_scenario_d)
 #' @format A data frame with 1000 rows.
 #' \describe{
-#'   \item{X}{Row number}
 #'   \item{SUBJID}{The patient identifier}
 #'   \item{GROUP}{Which type of outcome the row belongs to}
 #'   \item{GROUPN}{Not required for computation.