Merge pull request #148 from spsanderson/development

Development

NAMESPACE

@@ -13,6 +13,8 @@ export(enquo)
 export(enquos)
 export(expr)
 export(gartner_magic_chart_plt)
+export(hr_scale_color_colorblind)
+export(hr_scale_fill_colorblind)
 export(kmeans_mapped_tbl)
 export(kmeans_obj)
 export(kmeans_scree_data_tbl)
@@ -24,8 +26,6 @@ export(los_ra_index_summary_tbl)
 export(named_item_list)
 export(opt_bin)
 export(save_to_excel)
-export(scale_color_colorblind)
-export(scale_fill_colorblind)
 export(service_line_augment)
 export(service_line_vec)
 export(sql_left)

NEWS.md

@@ -4,8 +4,8 @@
 None
 
 ## New Features
-1. Fix #139 - Add functions `color_blind()` `scale_fill_colorblind()` 
-and `scale_color_colorblind()`
+1. Fix #139 - Add functions `color_blind()` `hr_scale_fill_colorblind()` 
+and `hr_scale_color_colorblind()`
 2. Fix #138 - Add parameter to `gartner_magic_chart_plt()` function in order to 
 size points accoring to a column in a data.frame/tibble.
 

R/gartner_magic_chart.R

@@ -8,7 +8,7 @@
 #' @param .data The data set you want to plot
 #' @param .x_col The x-axis for the plot
 #' @param .y_col The y-axis for the plot
-#' @param .plot_col_size The default is NULL, if you want to size the dots by
+#' @param .point_size_col The default is NULL, if you want to size the dots by
 #' a column in the data.frame/tibble then enter the column name here.
 #' @param .y_lab The y-axis label
 #' @param .x_lab The x-axis label
@@ -17,7 +17,6 @@
 #' @param .tl_lbl The top left label
 #' @param .bl_lbl The bottom left label
 #' @param .br_lbl The bottom right label
-#' @param .point_size The column you want to pass as a point size to `ggplot2`
 #'
 #' @details
 #' - Supply a data frame with at least two continuous variables to plot against

R/pallette-color-blind.R

@@ -1,7 +1,20 @@
 #' Provide Colorblind Compliant Colors
 #'
+#' @author Steven P. Sanderson II, MPH
+#'
+#' @details
+#' This function is used in others in order to help render plots for those that
+#' are color blind.
+#'
+#' @description
 #' 8 Hex RGB color definitions suitable for charts for colorblind people.
 #'
+#' @examples
+#' color_blind()
+#'
+#' @return
+#' A vector of 8 Hex RGB definitions.
+#'
 #' @export
 color_blind <- function(){
  c("#000000", "#E69F00", "#56B4E9",
@@ -10,22 +23,54 @@ color_blind <- function(){
 }
 
 #' Provide Colorblind Compliant Colors
+#'
+#' @author Steven P. Sanderson II, MPH
+#'
+#' @details
+#' This function is used in others in order to help render plots for those that
+#' are color blind.
+#'
+#' @description
+#' 8 Hex RGB color definitions suitable for charts for colorblind people.
+#'
+#' @param ... Data passed in from a `ggplot` object
+#' @param theme Right now this is `hr` only. Anything else will render an error.
+#'
+#' @return
+#' A `gggplot` layer
+#'
 #' @export
-scale_fill_colorblind <- function(..., theme = "td") {
+hr_scale_fill_colorblind <- function(..., theme = "hr") {
 
  pal <- switch(theme,
- "td" = unname(color_blind()) %>% rep(100)
+ "hr" = unname(color_blind()) %>% rep(100)
  )
 
  ggplot2::scale_fill_manual(values = pal)
 }
 
 #' Provide Colorblind Compliant Colors
+#'
+#' @author Steven P. Sanderson II, MPH
+#'
+#' @details
+#' This function is used in others in order to help render plots for those that
+#' are color blind.
+#'
+#' @description
+#' 8 Hex RGB color definitions suitable for charts for colorblind people.
+#'
+#' @param ... Data passed in from a `ggplot` object
+#' @param theme Right now this is `hr` only. Anything else will render an error.
+#'
+#' @return
+#' A `gggplot` layer
+#'
 #' @export
-scale_color_colorblind = function(..., theme = "td") {
+hr_scale_color_colorblind = function(..., theme = "hr") {
 
  pal <- switch(theme,
- "td" = unname(color_blind()) %>% rep(100)
+ "hr" = unname(color_blind()) %>% rep(100)
  )
 
  ggplot2::scale_color_manual(values = pal)

README.md

@@ -61,7 +61,7 @@ library(healthyR)
 library(timetk)
 
 ts_signature_tbl(.data = m4_daily, .date_col = date)
-#> # A tibble: 17,578 x 31
+#> # A tibble: 17,578 × 31
 #> id date value index.num diff year year.iso half quarter month
 #> <fct> <date> <dbl> <dbl> <dbl> <int> <int> <int> <int> <int>
 #> 1 D410 1978-06-23 9109. 267408000 NA 1978 1978 1 2 6
@@ -74,7 +74,7 @@ ts_signature_tbl(.data = m4_daily, .date_col = date)
 #> 8 D410 1978-06-30 9084. 268012800 86400 1978 1978 1 2 6
 #> 9 D410 1978-07-01 9081. 268099200 86400 1978 1978 2 3 7
 #> 10 D410 1978-07-02 9047. 268185600 86400 1978 1978 2 3 7
-#> # ... with 17,568 more rows, and 21 more variables: month.xts <int>,
+#> # … with 17,568 more rows, and 21 more variables: month.xts <int>,
 #> # month.lbl <ord>, day <int>, hour <int>, minute <int>, second <int>,
 #> # hour12 <int>, am.pm <int>, wday <int>, wday.xts <int>, wday.lbl <ord>,
 #> # mday <int>, qday <int>, yday <int>, mweek <int>, week <int>,