Update v6.4.0

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: simplevis
 Type: Package
 Title: Wrappers to Simplify Beautiful 'ggplot2' and 'leaflet' Visualisation
-Version: 6.3.0
+Version: 6.4.0
 Authors@R: 
     c(person(given = "David",
              family = "Hodge",
@@ -65,4 +65,4 @@ Suggests:
     tibble,
     tidytext
 VignetteBuilder: knitr
-RoxygenNote: 7.2.0
+RoxygenNote: 7.2.1

NEWS.md

@@ -1,3 +1,7 @@
+# simplevis 6.4.0
+
+* Deprecated essentially all ggplot2 wrapper functions. Users should use {ggblanket} instead.
+
 # simplevis 6.3.0
 
 * Deprecated: renamed theme v_gridlines/h_gridlines arguments to x_grid/y_grid. 

R/gg_bar.R

@@ -1,6 +1,6 @@
-#' @title Bar ggplot.
+#' @title DEPRECATED. Bar ggplot. 
 #' 
-#' @description Bar ggplot that is not coloured and not facetted.
+#' @description DEPRECATED. Bar ggplot that is not coloured and not facetted. 
 #' @param data A data frame in a structure to be plotted untransformed. Required input.
 #' @param x_var Unquoted variable to be on the x scale (i.e. character, factor, logical, numeric, date or datetime). If numeric, date or datetime, variable values are bins that are mutually exclusive and equidistant. Required input.
 #' @param y_var Unquoted numeric variable to be on the y scale. Required input.
@@ -91,6 +91,8 @@ gg_bar <- function(data,
                    theme = gg_theme(y_grid = TRUE),
                    mobile = FALSE) {
 
+  warning( "The `simplevis::gg_bar` function is deprecated as of {simplevis} 6.4.0. Please use the `ggblanket::gg_col` function instead.")
+
   #ungroup
   data <- dplyr::ungroup(data)
 
@@ -265,9 +267,9 @@ gg_bar <- function(data,
   return(plot)
 }
 
-#' @title Bar ggplot that is coloured.
+#' @title DEPRECATED. Bar ggplot that is coloured. 
 #' 
-#' @description Bar ggplot that is coloured, but not facetted.
+#' @description DEPRECATED. Bar ggplot that is coloured, but not facetted. 
 #' @param data A data frame in a structure to be plotted untransformed. Required input.
 #' @param x_var Unquoted variable to be on the x scale (i.e. character, factor, logical, numeric, date or datetime). If numeric, date or datetime, variable values are bins that are mutually exclusive and equidistant. Required input.
 #' @param y_var Unquoted numeric variable to be on the y scale. Required input.
@@ -395,6 +397,8 @@ gg_bar_col <- function(data,
                        theme = gg_theme(y_grid = TRUE),
                        mobile = FALSE){
 
+  warning( "The `simplevis::gg_bar_col` function is deprecated as of {simplevis} 6.4.0. Please use the `ggblanket::gg_col` function instead.")
+
   #ungroup
   data <- dplyr::ungroup(data)
 
@@ -725,9 +729,9 @@ gg_bar_col <- function(data,
   return(plot)
 }
 
-#' @title Bar ggplot that is facetted.
+#' @title DEPRECATED. Bar ggplot that is facetted. 
 #' 
-#' @description Bar ggplot that is facetted, but not coloured.
+#' @description DEPRECATED. Bar ggplot that is facetted, but not coloured. 
 #' @param data A data frame in a structure to be plotted untransformed. Required input.
 #' @param x_var Unquoted variable to be on the x scale (i.e. character, factor, logical, numeric, date or datetime). If numeric, date or datetime, variable values are bins that are mutually exclusive and equidistant. Required input.
 #' @param y_var Unquoted numeric variable to be on the y scale. Required input.
@@ -829,6 +833,8 @@ gg_bar_facet <- function(data,
                          caption_wrap = 80,
                          theme = gg_theme(y_grid = TRUE)) {
 
+  warning( "The `simplevis::gg_bar_facet` function is deprecated as of {simplevis} 6.4.0. Please use the `ggblanket::gg_col` function instead.")
+
   #ungroup
   data <- dplyr::ungroup(data)
 
@@ -1002,9 +1008,9 @@ gg_bar_facet <- function(data,
   return(plot)
 }
 
-#' @title Bar ggplot that is coloured and facetted.
+#' @title DEPRECATED. Bar ggplot that is coloured and facetted. 
 #' 
-#' @description Bar ggplot that is coloured and facetted.
+#' @description DEPRECATED. Bar ggplot that is coloured and facetted. 
 #' @param data A data frame in a structure to be plotted untransformed. Required input.
 #' @param x_var Unquoted variable to be on the x scale (i.e. character, factor, logical, numeric, date or datetime). If numeric, date or datetime, variable values are bins that are mutually exclusive and equidistant. Required input.
 #' @param y_var Unquoted numeric variable to be on the y scale. Required input.
@@ -1135,6 +1141,8 @@ gg_bar_col_facet <- function(data,
                              caption_wrap = 80,
                              theme = gg_theme(y_grid = TRUE)) {
 
+  warning( "The `simplevis::gg_bar_col_facet` function is deprecated as of {simplevis} 6.4.0. Please use the `ggblanket::gg_col` function instead.")
+
   #ungroup
   data <- dplyr::ungroup(data)
 

R/gg_boxplot.R

@@ -1,6 +1,6 @@
-#' @title Boxplot ggplot.
+#' @title DEPRECATED. Boxplot ggplot.
 #' 
-#' @description Boxplot ggplot that is not coloured and not facetted.
+#' @description DEPRECATED. Boxplot ggplot that is not coloured and not facetted.
 #' @param data A data frame generally in a structure to be transformed to boxplot statistics (or alternatively in a structure of summary boxplot statistics). Required input.
 #' @param x_var Unquoted categorical variable to be on the x scale (i.e. character, factor, logical). Required input.
 #' @param y_var Unquoted numeric variable to be on the y scale for when stat = "boxplot" is selected. 
@@ -111,6 +111,8 @@ gg_boxplot <- function(data,
                        theme = gg_theme(y_grid = TRUE),
                        mobile = FALSE) {
 
+  warning( "The `simplevis::gg_boxplot` function is deprecated as of {simplevis} 6.4.0. Please use the `ggblanket::gg_boxplot` function instead.")
+
   #ungroup
   data <- dplyr::ungroup(data)
 
@@ -267,9 +269,9 @@ gg_boxplot <- function(data,
   return(plot)
 }
 
-#' @title Boxplot ggplot that is coloured.
+#' @title DEPRECATED. Boxplot ggplot that is coloured.
 #' 
-#' @description Boxplot ggplot that is coloured, but not facetted.
+#' @description DEPRECATED. Boxplot ggplot that is coloured, but not facetted.
 #' @param data A data frame generally in a structure to be transformed to boxplot statistics (or alternatively in a structure of summary boxplot statistics). Required input.
 #' @param x_var Unquoted categorical variable to be on the x scale (i.e. character, factor, logical). Required input.
 #' @param y_var Unquoted numeric variable to be on the y scale for when stat = "boxplot" is selected. 
@@ -409,6 +411,8 @@ gg_boxplot_col <- function(data,
                            yupper_var = NULL,
                            ymax_var = NULL,
                            mobile = FALSE) {
+
+  warning( "The `simplevis::gg_boxplot_col` function is deprecated as of {simplevis} 6.4.0. Please use the `ggblanket::gg_boxplot` function instead.")
 
   #ungroup
   data <- dplyr::ungroup(data)
@@ -620,9 +624,9 @@ gg_boxplot_col <- function(data,
   return(plot)
 }
 
-#' @title Boxplot ggplot that is facetted.
+#' @title DEPRECATED. Boxplot ggplot that is facetted.
 #' 
-#' @description Boxplot ggplot that is facetted, but not coloured.
+#' @description DEPRECATED. Boxplot ggplot that is facetted, but not coloured.
 #' @param data A data frame generally in a structure to be transformed to boxplot statistics (or alternatively in a structure of summary boxplot statistics). Required input.
 #' @param x_var Unquoted categorical variable to be on the x scale (i.e. character, factor, logical). Required input.
 #' @param y_var Unquoted numeric variable to be on the y scale for when stat = "boxplot" is selected. 
@@ -725,6 +729,8 @@ gg_boxplot_facet <- function(data,
                              yupper_var = NULL,
                              ymax_var = NULL) {
 
+  warning( "The `simplevis::gg_boxplot_facet` function is deprecated as of {simplevis} 6.4.0. Please use the `ggblanket::gg_boxplot` function instead.")
+
   #ungroup
   data <- dplyr::ungroup(data)
 
@@ -896,9 +902,9 @@ gg_boxplot_facet <- function(data,
   return(plot)
 }
 
-#' @title Boxplot ggplot that is coloured and facetted.
+#' @title DEPRECATED. Boxplot ggplot that is coloured and facetted.
 #' 
-#' @description Boxplot ggplot that is coloured and facetted.
+#' @description DEPRECATED. Boxplot ggplot that is coloured and facetted.
 #' @param data A data frame generally in a structure to be transformed to boxplot statistics (or alternatively in a structure of summary boxplot statistics). Required input.
 #' @param x_var Unquoted categorical variable to be on the x scale (i.e. character, factor, logical). Required input.
 #' @param y_var Unquoted numeric variable to be on the y scale for when stat = "boxplot" is selected. 
@@ -1025,6 +1031,8 @@ gg_boxplot_col_facet <- function(data,
                                  yupper_var = NULL,
                                  ymax_var = NULL) {
 
+  warning( "The `simplevis::gg_boxplot_col_facet` function is deprecated as of {simplevis} 6.4.0. Please use the `ggblanket::gg_boxplot` function instead.")
+
   #ungroup
   data <- dplyr::ungroup(data)
 

R/gg_density.R

@@ -1,5 +1,5 @@
-#' @title Density ggplot.
-#' @description Density ggplot that is not coloured and not facetted.
+#' @title DEPRECATED. Density ggplot.
+#' @description DEPRECATED. Density ggplot that is not coloured and not facetted.
 #' @param data A data frame in a structure to be transformed to density statistics. Required input.
 #' @param x_var Unquoted numeric variable to be on the x scale. Required input.
 #' @param pal Character vector of hex codes. 
@@ -75,6 +75,8 @@ gg_density <- function(data,
                        model_trim = FALSE,
                        mobile = FALSE) {
 
+  warning( "The `simplevis::gg_density` function is deprecated as of {simplevis} 6.4.0. Please use the `ggblanket::gg_density` function instead.")
+
   #ungroup
   data <- dplyr::ungroup(data)
 
@@ -165,9 +167,9 @@ gg_density <- function(data,
   return(plot)
 }
 
-#' @title Density ggplot that is coloured.
+#' @title DEPRECATED. Density ggplot that is coloured.
 #' 
-#' @description Density ggplot that is coloured, but not facetted.
+#' @description DEPRECATED. Density ggplot that is coloured, but not facetted.
 #' @param data A data frame in a structure to be transformed to density statistics. Required input.
 #' @param x_var Unquoted numeric variable to be on the x scale. Required input.
 #' @param col_var Unquoted categorical variable to colour density areas. Required input.
@@ -261,6 +263,8 @@ gg_density_col <- function(data,
                            model_trim = FALSE,
                            mobile = FALSE) {
 
+  warning( "The `simplevis::gg_density_col` function is deprecated as of {simplevis} 6.4.0. Please use the `ggblanket::gg_density` function instead.")
+
   #ungroup
   data <- dplyr::ungroup(data)
 
@@ -404,9 +408,9 @@ gg_density_col <- function(data,
   return(plot)
 }
 
-#' @title Density ggplot that is facetted.
+#' @title DEPRECATED. Density ggplot that is facetted.
 #' 
-#' @description Density ggplot that is facetted, but not coloured.
+#' @description DEPRECATED. Density ggplot that is facetted, but not coloured.
 #' @param data A data frame in a structure to be transformed to density statistics. Required input.
 #' @param x_var Unquoted numeric variable to be on the x scale. Required input.
 #' @param facet_var Unquoted categorical variable to facet the data by. Required input.
@@ -495,6 +499,8 @@ gg_density_facet <- function(data,
                              model_n = 512,
                              model_trim = FALSE) {
 
+  warning( "The `simplevis::gg_density_facet` function is deprecated as of {simplevis} 6.4.0. Please use the `ggblanket::gg_density` function instead.")
+
   #ungroup
   data <- dplyr::ungroup(data)
 
@@ -596,9 +602,9 @@ gg_density_facet <- function(data,
   return(plot)
 }
 
-#' @title Density ggplot that is coloured and facetted.
+#' @title DEPRECATED. Density ggplot that is coloured and facetted.
 #' 
-#' @description Density ggplot that is coloured and facetted.
+#' @description DEPRECATED. Density ggplot that is coloured and facetted.
 #' @param data A data frame in a structure to be transformed to density statistics. Required input.
 #' @param x_var Unquoted numeric variable to be on the x scale. Required input.
 #' @param col_var Unquoted categorical variable to colour density areas. Required input.
@@ -705,6 +711,8 @@ gg_density_col_facet <- function(data,
                                  model_n = 512,
                                  model_trim = FALSE) {
 
+  warning( "The `simplevis::gg_density_col_facet` function is deprecated as of {simplevis} 6.4.0. Please use the `ggblanket::gg_density` function instead.")
+
   #ungroup
   data <- dplyr::ungroup(data)
 

R/gg_hbar.R

@@ -1,5 +1,5 @@
-#' @title Horizontal bar ggplot.
-#' @description Horizontal bar ggplot that is not coloured and not facetted.
+#' @title DEPRECATED. Horizontal bar ggplot.
+#' @description DEPRECATED. Horizontal bar ggplot that is not coloured and not facetted.
 #' @param data An ungrouped summarised tibble or data frame in a structure to be plotted untransformed. Required input.
 #' @param x_var Unquoted numeric variable to be on the x scale. Required input.
 #' @param y_var Unquoted variable to be on the y scale (i.e. character, factor, logical, numeric, date or datetime). If numeric, date or datetime, variable values are bins that are mutually exclusive and equidistant. Required input.
@@ -91,6 +91,8 @@ gg_hbar <- function(data,
                     theme = gg_theme(x_grid = TRUE),
                     mobile = FALSE) {
 
+  warning( "The `simplevis::gg_hbar` function is deprecated as of {simplevis} 6.4.0. Please use the `ggblanket::gg_col` function instead.")
+
   #ungroup
   data <- dplyr::ungroup(data)
 
@@ -266,8 +268,8 @@ gg_hbar <- function(data,
   return(plot)
 }
 
-#' @title Horizontal bar ggplot that is coloured.
-#' @description Horizontal bar ggplot that is coloured, but not facetted.
+#' @title DEPRECATED. Horizontal bar ggplot that is coloured.
+#' @description DEPRECATED. Horizontal bar ggplot that is coloured, but not facetted.
 #' @param data An ungrouped summarised tibble or data frame in a structure to be plotted untransformed. Required input.
 #' @param x_var Unquoted numeric variable to be on the x scale. Required input.
 #' @param y_var Unquoted variable to be on the y scale (i.e. character, factor, logical, numeric, date or datetime). If numeric, date or datetime, variable values are bins that are mutually exclusive and equidistant. Required input.
@@ -395,6 +397,8 @@ gg_hbar_col <- function(data,
                         theme = gg_theme(x_grid = TRUE),
                         mobile = FALSE) {
 
+  warning( "The `simplevis::gg_hbar_col` function is deprecated as of {simplevis} 6.4.0. Please use the `ggblanket::gg_col` function instead.")
+
   #ungroup
   data <- dplyr::ungroup(data)
 
@@ -727,8 +731,8 @@ gg_hbar_col <- function(data,
   return(plot)
 }
 
-#' @title Horizontal bar ggplot that is facetted.
-#' @description Horizontal bar ggplot that is facetted, but not coloured.
+#' @title DEPRECATED. Horizontal bar ggplot that is facetted.
+#' @description DEPRECATED. Horizontal bar ggplot that is facetted, but not coloured.
 #' @param data An ungrouped summarised tibble or data frame in a structure to be plotted untransformed. Required input.
 #' @param x_var Unquoted numeric variable to be on the x scale. Required input.
 #' @param y_var Unquoted variable to be on the y scale (i.e. character, factor, logical, numeric, date or datetime). If numeric, date or datetime, variable values are bins that are mutually exclusive and equidistant. Required input.
@@ -831,6 +835,8 @@ gg_hbar_facet <- function(data,
                           caption_wrap = 75,
                           theme = gg_theme(x_grid = TRUE)) {
 
+  warning( "The `simplevis::gg_hbar_facet` function is deprecated as of {simplevis} 6.4.0. Please use the `ggblanket::gg_col` function instead.")
+
   #ungroup
   data <- dplyr::ungroup(data)
 
@@ -1005,8 +1011,8 @@ gg_hbar_facet <- function(data,
   return(plot)
 }
 
-#' @title Horizontal bar ggplot that is coloured and facetted.
-#' @description Horizontal bar ggplot that is coloured and facetted.
+#' @title DEPRECATED. Horizontal bar ggplot that is coloured and facetted.
+#' @description DEPRECATED. Horizontal bar ggplot that is coloured and facetted.
 #' @param data An ungrouped summarised tibble or data frame in a structure to be plotted untransformed. Required input.
 #' @param x_var Unquoted numeric variable to be on the x scale. Required input.
 #' @param y_var Unquoted variable to be on the y scale (i.e. character, factor, logical, numeric, date or datetime). If numeric, date or datetime, variable values are bins that are mutually exclusive and equidistant. Required input.
@@ -1138,6 +1144,8 @@ gg_hbar_col_facet <- function(data,
                               caption_wrap = 75,
                               theme = gg_theme(x_grid = TRUE)) {
 
+  warning( "The `simplevis::gg_hbar_col_facet` function is deprecated as of {simplevis} 6.4.0. Please use the `ggblanket::gg_col` function instead.")
+
   #ungroup
   data <- dplyr::ungroup(data)
 
@@ -1476,4 +1484,4 @@ gg_hbar_col_facet <- function(data,
   }
 
   return(plot)
-}
+}