Prepare for next release

tesselle · Jun 14, 2021 · 1315260 · 1315260
1 parent 80930a6
commit 1315260
Show file tree

Hide file tree

Showing 18 changed files with 212 additions and 106 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: khroma
 Title: Colour Schemes for Scientific Data Visualization
-Version: 1.5.0.9000
+Version: 1.6.0
 Authors@R: 
     c(person(given = "Nicolas",
              family = "Frerebeau",
@@ -33,17 +33,19 @@ BugReports: https://github.com/tesselle/khroma/issues
 Depends: 
     R (>= 3.3)
 Imports:
-    ggplot2,
     grDevices,
     grid,
-    scales,
-    spacesXYZ
+    stats,
+    utils
 Suggests:
     covr,
     crayon,
     fansi,
+    ggplot2,
     knitr,
     rmarkdown,
+    scales,
+    spacesXYZ,
     testthat (>= 3.0.0),
     vdiffr
 VignetteBuilder:

diff --git a/NAMESPACE b/NAMESPACE
@@ -170,17 +170,10 @@ export(scale_fill_vanimo)
 export(scale_fill_vibrant)
 export(scale_fill_vik)
 export(scale_fill_vikO)
-importFrom(ggplot2,aes)
-importFrom(ggplot2,continuous_scale)
-importFrom(ggplot2,discrete_scale)
-importFrom(ggplot2,scale_color_manual)
-importFrom(ggplot2,scale_fill_manual)
+importFrom(grDevices,col2rgb)
 importFrom(grDevices,colorRampPalette)
 importFrom(grid,gpar)
 importFrom(grid,grid.newpage)
 importFrom(grid,grid.rect)
 importFrom(grid,grid.text)
 importFrom(grid,unit)
-importFrom(scales,alpha)
-importFrom(scales,gradient_n_pal)
-importFrom(scales,rescale_mid)
diff --git a/NEWS.md b/NEWS.md
@@ -1,8 +1,11 @@
-# khroma 1.5.0.9000
+# khroma 1.6.0
 
 ## New functions
 * Add `info()` to get a table of all available palettes.
 
+## Internals
+* Move **ggplot2**, **scales** and **spacesXYZ** from Imports to Suggests (#8).
+
 # khroma 1.5.0
 
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4723613.svg)](https://doi.org/10.5281/zenodo.4723613)

diff --git a/R/compare.R b/R/compare.R
@@ -16,6 +16,7 @@
 #' @export
 compare <- function(x, metric = 2000, diag = FALSE, upper = FALSE) {
   # Validation
+  check_package("spacesXYZ")
   if (!is.atomic(x) || !is.character(x))
     stop("x must be a character vector of colours.", call. = FALSE)
 

diff --git a/R/ggplot2.R b/R/ggplot2.R
@@ -34,6 +34,9 @@ NULL
 
 scale_discrete <- function(aesthetics, scale_name, reverse = FALSE,
                            use_names = FALSE, lang = "en", ...) {
+  # Check if ggplot2 is installed
+  check_package("ggplot2")
+
   # Get colour scheme
   palette <- colour(scale_name, reverse = reverse, names = use_names,
                     lang = lang)
@@ -51,6 +54,9 @@ scale_discrete <- function(aesthetics, scale_name, reverse = FALSE,
 
 scale_continuous <- function(aesthetics, scale_name, reverse = FALSE,
                              lang = "en", range = c(0, 1), midpoint = 0, ...) {
+  # Validation
+  check_package("ggplot2") # Check if ggplot2 is installed
+
   # Get colour scheme
   palette <- colour(scale_name, reverse = reverse, names = FALSE, lang = lang)
   max <- attr(palette, "max")
@@ -79,6 +85,7 @@ scale_continuous <- function(aesthetics, scale_name, reverse = FALSE,
 #' @keywords internal
 #' @noRd
 mid_rescaler <- function(mid) {
+  check_package("scales") # Check if scales is installed
   function(x, to = c(0, 1), from = range(x, na.rm = TRUE)) {
     scales::rescale_mid(x, to, from, mid)
   }

diff --git a/R/khroma-package.R b/R/khroma-package.R
@@ -2,12 +2,11 @@
 #'  \tabular{ll}{
 #'   **Package:** \tab khroma \cr
 #'   **Type:** \tab Package \cr
-#'   **Version:** \tab 1.5.0.9000 \cr
+#'   **Version:** \tab 1.6.0 \cr
 #'   **License:** \tab GPL-3 \cr
+#'   **Zenodo:** \tab \doi{10.5281/zenodo.1472077} \cr
 #'  }
 #'
-#' \doi{10.5281/zenodo.1472077}
-#'
 #' @author
 #'  **Full list of authors and contributors** (alphabetic order)
 #'  \tabular{ll}{
@@ -32,9 +31,18 @@
 #' @keywords internal
 "_PACKAGE"
 
-#' @importFrom ggplot2 aes continuous_scale discrete_scale scale_color_manual
-#' scale_fill_manual
-#' @importFrom scales alpha gradient_n_pal rescale_mid
-#' @importFrom grDevices colorRampPalette
+# @importFrom ggplot2 aes continuous_scale discrete_scale scale_color_manual
+# scale_fill_manual
+# @importFrom scales alpha gradient_n_pal rescale_mid
+# @importFrom spacesXYZ DeltaE
+#' @importFrom grDevices col2rgb colorRampPalette
 #' @importFrom grid gpar grid.newpage grid.rect grid.text unit
 NULL
+
+check_package <- function(x) {
+  if (!requireNamespace(x, quietly = TRUE)) {
+    msg <- "Package %s needed for this function to work. Please install it."
+    stop(sprintf(msg, x), call. = FALSE)
+  }
+  invisible(NULL)
+}
diff --git a/README.Rmd b/README.Rmd
@@ -61,10 +61,13 @@ remotes::install_github("tesselle/khroma")
 ```
 
 ## Usage
+
 ```{r packages}
-# Load packages
+## Load packages
 library(khroma)
-library(ggplot2)
+
+## Install extra packages (if needed)
+# install.packages(c("ggplot2", "spacesXYZ"))
 ```
 
 <details>
@@ -109,7 +112,10 @@ plot_scheme(bright(7), colours = TRUE)
 
 ```{r usage-ggplot2, fig.height=3.5, fig.width=5, fig.align='center'}
 # Use with ggplot2
-ggplot2::ggplot(data = mpg, mapping = aes(x = displ, y = hwy, colour = class)) +
+data(mpg, package = "ggplot2")
+
+ggplot2::ggplot(data = mpg) +
+  ggplot2::aes(x = displ, y = hwy, colour = class) +
   ggplot2::geom_point() +
   scale_colour_bright()
 ```

diff --git a/README.md b/README.md
@@ -65,9 +65,11 @@ remotes::install_github("tesselle/khroma")
 ## Usage
 
 ``` r
-# Load packages
+## Load packages
 library(khroma)
-library(ggplot2)
+
+## Install extra packages (if needed)
+# install.packages(c("ggplot2", "spacesXYZ"))
 ```
 
 <details>
@@ -173,7 +175,10 @@ plot_scheme(bright(7), colours = TRUE)
 
 ``` r
 # Use with ggplot2
-ggplot2::ggplot(data = mpg, mapping = aes(x = displ, y = hwy, colour = class)) +
+data(mpg, package = "ggplot2")
+
+ggplot2::ggplot(data = mpg) +
+  ggplot2::aes(x = displ, y = hwy, colour = class) +
   ggplot2::geom_point() +
   scale_colour_bright()
 ```

diff --git a/codemeta.json b/codemeta.json
@@ -14,7 +14,7 @@
   ],
   "issueTracker": "https://github.com/tesselle/khroma/issues",
   "license": "https://spdx.org/licenses/GPL-3.0",
-  "version": "1.5.0.9000",
+  "version": "1.6.0",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",
@@ -100,6 +100,18 @@
       },
       "sameAs": "https://CRAN.R-project.org/package=fansi"
     },
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "ggplot2",
+      "name": "ggplot2",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Comprehensive R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      },
+      "sameAs": "https://CRAN.R-project.org/package=ggplot2"
+    },
     {
       "@type": "SoftwareApplication",
       "identifier": "knitr",
@@ -124,6 +136,30 @@
       },
       "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
     },
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "scales",
+      "name": "scales",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Comprehensive R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      },
+      "sameAs": "https://CRAN.R-project.org/package=scales"
+    },
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "spacesXYZ",
+      "name": "spacesXYZ",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Comprehensive R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      },
+      "sameAs": "https://CRAN.R-project.org/package=spacesXYZ"
+    },
     {
       "@type": "SoftwareApplication",
       "identifier": "testthat",
@@ -157,18 +193,6 @@
       "name": "R",
       "version": ">= 3.3"
     },
-    {
-      "@type": "SoftwareApplication",
-      "identifier": "ggplot2",
-      "name": "ggplot2",
-      "provider": {
-        "@id": "https://cran.r-project.org",
-        "@type": "Organization",
-        "name": "Comprehensive R Archive Network (CRAN)",
-        "url": "https://cran.r-project.org"
-      },
-      "sameAs": "https://CRAN.R-project.org/package=ggplot2"
-    },
     {
       "@type": "SoftwareApplication",
       "identifier": "grDevices",
@@ -181,31 +205,17 @@
     },
     {
       "@type": "SoftwareApplication",
-      "identifier": "scales",
-      "name": "scales",
-      "provider": {
-        "@id": "https://cran.r-project.org",
-        "@type": "Organization",
-        "name": "Comprehensive R Archive Network (CRAN)",
-        "url": "https://cran.r-project.org"
-      },
-      "sameAs": "https://CRAN.R-project.org/package=scales"
+      "identifier": "stats",
+      "name": "stats"
     },
     {
       "@type": "SoftwareApplication",
-      "identifier": "spacesXYZ",
-      "name": "spacesXYZ",
-      "provider": {
-        "@id": "https://cran.r-project.org",
-        "@type": "Organization",
-        "name": "Comprehensive R Archive Network (CRAN)",
-        "url": "https://cran.r-project.org"
-      },
-      "sameAs": "https://CRAN.R-project.org/package=spacesXYZ"
+      "identifier": "utils",
+      "name": "utils"
     }
   ],
   "readme": "https://github.com/tesselle/khroma/blob/master/README.md",
-  "fileSize": "1326.543KB",
+  "fileSize": "1334.651KB",
   "contIntegration": "https://codecov.io/gh/tesselle/khroma",
   "developmentStatus": "https://www.repostatus.org/#active",
   "keywords": [
@@ -229,7 +239,7 @@
       ],
       "name": "khroma: Colour Schemes for Scientific Data Visualization",
       "url": "https://doi.org/10.5281/zenodo.1472077",
-      "description": "R package version 1.5.0"
+      "description": "R package version 1.6.0"
     }
   ],
   "releaseNotes": "https://github.com/tesselle/khroma/blob/master/NEWS.md"

diff --git a/cran-comments.md b/cran-comments.md
@@ -10,7 +10,7 @@
 
 ## Reverse dependencies
 
-We checked 2 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
+We checked 3 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
 
 * We saw 0 new problems
 * We failed to check 0 packages
diff --git a/inst/CITATION b/inst/CITATION
@@ -7,14 +7,14 @@ citEntry(
   year         = "2021",
   organization = "Université Bordeaux Montaigne",
   address      = "Pessac, France",
-  note         = "R package version 1.5.0",
+  note         = "R package version 1.6.0",
   url          = "https://doi.org/10.5281/zenodo.1472077",
 
   textVersion  =
   paste("Frerebeau, Nicolas (2021).",
         "khroma: Colour Schemes for Scientific Data Visualization.",
-        "R package version 1.5.0",
+        "R package version 1.6.0",
         "Université Bordeaux Montaigne, Pessac, France.",
         "DOI 10.5281/zenodo.1472077.",
-        "URL https://khroma.tesselle.org.")
+        "URL https://packages.tesselle.org/khroma.")
 )
diff --git a/man/khroma-package.Rd b/man/khroma-package.Rd
diff --git a/_pkgdown.yml → pkgdown/_pkgdown.yml b/_pkgdown.yml → pkgdown/_pkgdown.yml
@@ -7,7 +7,7 @@ template:
   opengraph:
     twitter:
       creator: "@nfrerebeau"
-      card: summary_large_image
+      card: summary
 
 reference:
 - title: Colour Palette