Merge pull request #6 from katelyndiaz/CRAN

cran

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

@@ -2,9 +2,9 @@
 # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
 on:
   push:
-    branches: [main, master]
+    branches: [main, master, CRAN]
   pull_request:
-    branches: [main, master]
+    branches: [main, master, CRAN]
 
 name: R-CMD-check
 

.github/workflows/r.yml

@@ -10,9 +10,9 @@ name: R
 
 on:
   push:
-    branches: [ main ]
+    branches: [ main, CRAN ]
   pull_request:
-    branches: [ main ]
+    branches: [ main, CRAN ]
 
 permissions:
   contents: read
@@ -22,7 +22,7 @@ jobs:
     runs-on: macos-latest
     strategy:
       matrix:
-        r-version: ['3.6.3', '4.1.1']
+        r-version: ['4.1.1']
 
     steps:
       - uses: actions/checkout@v3

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: ggRtsy
 Type: Package
-Title: Add Some Van Gogh Colors and Overlay Colors on Your `ggplot()`
+Title: Add Some Van Gogh Colors and Overlay Colors on Your 'ggplot()'
 Version: 0.1.0
 Authors@R: c(
   person("Katelyn", "Diaz", email = "katndiaz@gmail.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-6108-1682")),
@@ -9,14 +9,14 @@ Authors@R: c(
   person("Aushanae", "Haller", email = "aushanaenhaller@gmail.com", role = "edt", comment = c(ORCID = "0000-0002-2090-1952"))
     )
 Maintainer: Katelyn Diaz <katndiaz@gmail.com>
-Description: Works with `ggplot2()` to add a Van Gogh color palette to the user’s repertoire.
- It also has a function that work alongside `ggplot2()` to create more interesting data visualizations and add contextual information to the user’s plots.
+Description: Works with 'ggplot2()' to add a Van Gogh color palette to the user’s repertoire.
+ It also has a function that work alongside 'ggplot2()' to create more interesting data visualizations and add contextual information to the user’s plots.
 License: CC0
 Encoding: UTF-8
 LazyData: true
 Depends: 
     R (>= 2.10)
-RoxygenNote: 7.2.1
+RoxygenNote: 7.2.3
 Imports:
   purrr,
   stringr,

R/PaletteColors.R

@@ -33,6 +33,11 @@ gogh_interpolate <- function(palette = "starryNight", reverse = FALSE, ...) {
 #' @param reverse Boolean, will be TRUE if the user wants the palette reversed
 #' @param discrete Boolean if color aesthetic is discrete
 #' @param ... further arguments passed to [ggRtsy::scale_color_gogh()]
+#' @examples
+#' if (require(ggplot2)) {
+#'   data <- data.frame(c = LETTERS[1:3],x = c(1,5,7),y = c(5,9,13))
+#'   ggplot(data, aes(x,y,color = c))+geom_point()+scale_color_gogh()
+#' }
 #' @export
 #' @return A ggplot2 color scale.
 #'   If `discrete` is TRUE, it returns a discrete color scale; otherwise, a continuous color scale.
@@ -43,7 +48,7 @@ scale_color_gogh <- function(palette = "starryNight",
   if (discrete == TRUE) {
     ggplot2::discrete_scale("colour", paste0("gogh_", palette), palette = pal, ...)
   } else {
-    ggplot2::scale_colour_gradientn(colours = pal(256), ...)
+    ggplot2::scale_colour_gradientn(colours = pal(256), ...) # gradient is the default for continuous
   }
 }
 
@@ -53,6 +58,11 @@ scale_color_gogh <- function(palette = "starryNight",
 #' @param reverse Boolean if the palette should be reversed
 #' @param ... Additional arguments used to discrete_scale() or scale_fill_gradientn()
 #'   to automatically interpolate between colors.
+#' @examples
+#' if (require(ggplot2)) {
+#'   data <- data.frame(c = LETTERS[1:3],x = c(1,5,7),y = c(5,9,13))
+#'   ggplot(data, aes(x,fill=c))+geom_bar()+scale_fill_gogh()
+#' }
 #' @export
 #' @return No return value. Called for side effects.
 scale_fill_gogh <- function(palette = "sunflowers", discrete = TRUE, reverse = FALSE, ...) {
@@ -64,14 +74,3 @@ scale_fill_gogh <- function(palette = "sunflowers", discrete = TRUE, reverse = F
   }
 }
 
-#' @examples
-#' if (require(ggplot2)) {
-#'   data <- data.frame(c = LETTERS[1:3],x = c(1,5,7),y = c(5,9,13))
-#'   ggplot(data, aes(x,y,color = c))+geom_point()+scale_color_gogh()
-#' }
-
-#' @examples
-#' if (require(ggplot2)) {
-#'   data <- data.frame(c = LETTERS[1:3],x = c(1,5,7),y = c(5,9,13))
-#'   ggplot(data, aes(x,fill=c))+geom_bar()+scale_fill_gogh()
-#' }