diff --git a/DESCRIPTION b/DESCRIPTION index 6da6b4b..bbee66b 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -12,6 +12,8 @@ URL: https://github.com/fhdsl/AnVILplot BugReports: https://github.com/fhdsl/AnVILplot/issues Encoding: UTF-8 Roxygen: list(markdown = TRUE) -RoxygenNote: 7.3.1 +RoxygenNote: 7.3.2 Depends: - palettes + palettes, + R (>= 2.10) +LazyData: true diff --git a/NAMESPACE b/NAMESPACE index 6ae9268..10d8fc0 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,2 +1,3 @@ # Generated by roxygen2: do not edit by hand +import(palettes) diff --git a/R/AnVILplot-package.R b/R/AnVILplot-package.R index a65cf64..a03c0a8 100644 --- a/R/AnVILplot-package.R +++ b/R/AnVILplot-package.R @@ -1,6 +1,9 @@ #' @keywords internal "_PACKAGE" -## usethis namespace: start -## usethis namespace: end +#' Internal palettes methods +#' +#' @import palettes +#' @keywords internal +#' @name anvil-palette NULL diff --git a/R/anvil_palette.R b/R/anvil_palette.R new file mode 100644 index 0000000..baff3e6 --- /dev/null +++ b/R/anvil_palette.R @@ -0,0 +1,73 @@ +#' The Analysis Visualization and Informatics Lab-space (AnVIL) Palettes +#' +#' Palettes inspired by the official colors of the AnVIL + +#' @format ## `anvil_palettes` +#' An object of class `palettes_palette` with `r length("anvil_palettes")` +#' colour palettes. Use `names("anvil_palettes")` to return all palette names. +#' @source +#' @author [Kate Isaac](https://github.com/kweav) +#' @seealso [pal_palette()], [pal_colour()] +#' @examples +#' # Get all palettes by name. +#' names(anvil_palettes) +#' +#' # Plot all palettes. +#' plot(anvil_palettes) +"anvil_palettes" + +#' @rdname anvil_palettes +#' @format ## `anvil_palette_discrete` +#' An object of class `palettes_palette` with +#' `r length(anvil_palette_discrete)` discrete colour palettes. +#' Use `names(anvil_palette_discrete)` to return all palette names. +"anvil_palette_discrete" + +#' @rdname anvil_palettes +#' @format ## `anvil_palette_sequential` +#' An object of class `palettes_palette` with +#' `r length(anvil_palette_sequential)` sequential colour palettes. +#' Use `names(anvil_palette_sequential)` to return all palette names. +"anvil_palette_sequential" + +#' @rdname anvil_palettes +#' @format ## `anvil_palette_sequential_blues` +#' An object of class `palettes_palette` with +#' `r length(anvil_palette_sequential_blues)` sequential colour palettes. +#' Use `names(anvil_palette_sequential_blues)` to return all palette names. +"anvil_palette_sequential_blues" + +#' @rdname anvil_palettes +#' @format ## `anvil_palette_diverging` +#' An object of class `palettes_palette` with +#' `r length(anvil_palette_diverging)` diverging colour palettes. +#' Use `names(anvil_palette_diverging)` to return all palette names. +"anvil_palette_diverging" + +#' @rdname anvil_palettes +#' @format ## `anvil_palette_full` +#' An object of class `palettes_palette` with +#' `r length(anvil_palette_full)` colour palettes. +#' Use `names(anvil_palette_full)` to return all palette names. +"anvil_palette_full" + +#' @rdname anvil_palettes +#' @format ## `anvil_palette_contrast2` +#' An object of class `palettes_palette` with +#' `r length(anvil_palette_contrast2)` contrasting colour palettes. +#' Use `names(anvil_palette_contrast2)` to return all palette names. +"anvil_palette_contrast2" + +#' @rdname anvil_palettes +#' @format ## `anvil_palette_complement2` +#' An object of class `palettes_palette` with +#' `r length(anvil_palette_complement2)`complementing colour palettes. +#' Use `names(anvil_palette_complement2)` to return all palette names. +"anvil_palette_complement2" + +#' @rdname anvil_palettes +#' @format ## `anvil_palette_single` +#' An object of class `palettes_palette` with +#' `r length(anvil_palette_single)` colour palettes. +#' Use `names(anvil_palette_single)` to return all palette names. +"anvil_palette_single" diff --git a/R/palettes.R b/R/palettes.R deleted file mode 100644 index e69de29..0000000 diff --git a/data-raw/anvil_palette.R b/data-raw/anvil_palette.R index bdaf716..262b23f 100644 --- a/data-raw/anvil_palette.R +++ b/data-raw/anvil_palette.R @@ -2,15 +2,13 @@ library(palettes) - #' A light and dark discrete palette for AnVIL #' #' This color palette is a discrete color palette with #' 4 dark colors and 4 light colors, all from the #' [AnVIL style guide](https://anvilproject.org/guides/style/color-palette). #' These are created manually. -#' -#' @import palettes + anvil_palette_discrete <- pal_palette( light = c("#F2F2F2", "#E0DD10", "#AEEBF2", "#7EBAC0"), dark = c("#035C94","#012840", "#25445A", "#333333") @@ -28,8 +26,7 @@ usethis::use_data(anvil_palette_discrete, overwrite = TRUE) #' These are programmatically defined and the base colors used #' to make the color ramps are from the #' [AnVIL style guide](https://anvilproject.org/guides/style/color-palette). -#' -#' @import palettes + anvil_palette_sequential <- pal_palette( blue = pal_ramp(pal_colour(c("#035C94", "#012840")), n = 7), lightgreen = pal_ramp(pal_colour(c("#F2F2F2", "#7EBAC0")), n =7), @@ -40,6 +37,21 @@ plot(anvil_palette_sequential) usethis::use_data(anvil_palette_sequential, overwrite = TRUE) +#' A sequential blue palette for AnVIL +#' +#' This color palette is a sequential color palette with +#' just blues, using base colors from the +#' [AnVIL style guide](https://anvilproject.org/guides/style/color-palette). + + +anvil_palette_sequential_blues <- pal_palette( + c("#035C94","#035385","#024A77","#024168", "#02395B") +) + +plot(anvil_palette_sequential_blues) + +usethis::use_data(anvil_palette_sequential_blues, overwrite = TRUE) + #' A diverging color palette for AnVIL #' #' This color palette is a diverging color palette with @@ -48,8 +60,7 @@ usethis::use_data(anvil_palette_sequential, overwrite = TRUE) #' These are programmatically defined and the base colors used #' to make the color ramps are from the #' [AnVIL style guide](https://anvilproject.org/guides/style/color-palette). -#' -#' @import palettes + anvil_palette_diverging <- pal_palette( c(pal_ramp(pal_colour(c("#012840","#035C94")), n = 7), #make 7 colors from dark blue to primary AnVIL blue @@ -63,30 +74,70 @@ plot(anvil_palette_diverging) usethis::use_data(anvil_palette_diverging, overwrite = TRUE) + #' Full palette for AnVIL #' #' This color palette lists all of the colors from the #' [AnVIL style guide](https://anvilproject.org/guides/style/color-palette). -#' -#' @import palettes -anvil_palette <- pal_palette( - anvil_colors = c("#035C94", "#012840", "#F6F7F4", "#F2F2F2", "#E0DD10", "#AEEBF2", "#7EBAC0", "#25445A", "#333333") + +anvil_palette_full <- pal_palette( + c("#035C94", "#012840", "#F6F7F4", "#F2F2F2", "#E0DD10", "#AEEBF2", "#7EBAC0", "#25445A", "#333333") ) -plot(anvil_palette) +plot(anvil_palette_full) -usethis::use_data(anvil_palette, overwrite = TRUE) +usethis::use_data(anvil_palette_full, overwrite = TRUE) #' Qualitative Binary palette for AnVIL #' #' This color palette takes two contrasting colors from the #' [AnVIL style guide](https://anvilproject.org/guides/style/color-palette) and uses them as the color palette. -#' -#' @import palettes -anvil_palette_set2 <- pal_palette( + +anvil_palette_contrast2 <- pal_palette( c("#035C94", "#E0DD10") ) -plot(anvil_palette_set2) +plot(anvil_palette_contrast2) + +usethis::use_data(anvil_palette_contrast2, overwrite = TRUE) + +#' Qualitative secondary binary palette for AnVIL +#' +#' This color palete takes two complementary colors from the +#' [AnVIL style guide](https://anvilproject.org/guides/style/color-palette) and uses them as the color palette. + +anvil_palette_complement2 <- pal_palette( + c("#25445A", "#7EBAC0") +) + +plot(anvil_palette_complement2) + +usethis::use_data(anvil_palette_complement2, overwrite = TRUE) + +#' Single AnVIL color +#' +#' This is a single color from the +#' [AnVIL style guide](https://anvilproject.org/guides/style/color-palette) and uses them as the color palette. + +anvil_palette_single <- pal_palette( + c("#25445A") +) + +plot(anvil_palette_single) + +usethis::use_data(anvil_palette_single, overwrite = TRUE) + + +# All palettes +anvil_palettes <- c( + anvil_palette_discrete, + anvil_palette_sequential, + anvil_palette_sequential_blues, + anvil_palette_diverging, + anvil_palette_full, + anvil_palette_contrast2, + anvil_palette_complement2, + anvil_palette_single +) -usethis::use_data(anvil_palette_set2, overwrite = TRUE) +usethis::use_data(anvil_palettes, overwrite = TRUE) diff --git a/data/anvil_palette_complement2.rda b/data/anvil_palette_complement2.rda new file mode 100644 index 0000000..778810f Binary files /dev/null and b/data/anvil_palette_complement2.rda differ diff --git a/data/anvil_palette_contrast2.rda b/data/anvil_palette_contrast2.rda new file mode 100644 index 0000000..eb86482 Binary files /dev/null and b/data/anvil_palette_contrast2.rda differ diff --git a/data/anvil_palette_discrete.rda b/data/anvil_palette_discrete.rda new file mode 100644 index 0000000..3827294 Binary files /dev/null and b/data/anvil_palette_discrete.rda differ diff --git a/data/anvil_palette_diverging.rda b/data/anvil_palette_diverging.rda new file mode 100644 index 0000000..effbc1d Binary files /dev/null and b/data/anvil_palette_diverging.rda differ diff --git a/data/anvil_palette_full.rda b/data/anvil_palette_full.rda new file mode 100644 index 0000000..12970f9 Binary files /dev/null and b/data/anvil_palette_full.rda differ diff --git a/data/anvil_palette_sequential.rda b/data/anvil_palette_sequential.rda new file mode 100644 index 0000000..33b5d2c Binary files /dev/null and b/data/anvil_palette_sequential.rda differ diff --git a/data/anvil_palette_sequential_blues.rda b/data/anvil_palette_sequential_blues.rda new file mode 100644 index 0000000..9346117 Binary files /dev/null and b/data/anvil_palette_sequential_blues.rda differ diff --git a/data/anvil_palette_single.rda b/data/anvil_palette_single.rda new file mode 100644 index 0000000..58ece02 Binary files /dev/null and b/data/anvil_palette_single.rda differ diff --git a/data/anvil_palettes.rda b/data/anvil_palettes.rda new file mode 100644 index 0000000..ccd581d Binary files /dev/null and b/data/anvil_palettes.rda differ diff --git a/man/anvil_palettes.Rd b/man/anvil_palettes.Rd new file mode 100644 index 0000000..faf9e9c --- /dev/null +++ b/man/anvil_palettes.Rd @@ -0,0 +1,116 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/anvil_palette.R +\docType{data} +\name{anvil_palettes} +\alias{anvil_palettes} +\alias{anvil_palette_discrete} +\alias{anvil_palette_sequential} +\alias{anvil_palette_sequential_blues} +\alias{anvil_palette_diverging} +\alias{anvil_palette_full} +\alias{anvil_palette_contrast2} +\alias{anvil_palette_complement2} +\alias{anvil_palette_single} +\title{The Analysis Visualization and Informatics Lab-space (AnVIL) Palettes} +\format{ +\subsection{\code{anvil_palettes}}{ + +An object of class \code{palettes_palette} with 1 +colour palettes. Use \code{names("anvil_palettes")} to return all palette names. +} + +\subsection{\code{anvil_palette_discrete}}{ + +An object of class \code{palettes_palette} with +2 discrete colour palettes. +Use \code{names(anvil_palette_discrete)} to return all palette names. +} + +\subsection{\code{anvil_palette_sequential}}{ + +An object of class \code{palettes_palette} with +3 sequential colour palettes. +Use \code{names(anvil_palette_sequential)} to return all palette names. +} + +\subsection{\code{anvil_palette_sequential_blues}}{ + +An object of class \code{palettes_palette} with +1 sequential colour palettes. +Use \code{names(anvil_palette_sequential_blues)} to return all palette names. +} + +\subsection{\code{anvil_palette_diverging}}{ + +An object of class \code{palettes_palette} with +1 diverging colour palettes. +Use \code{names(anvil_palette_diverging)} to return all palette names. +} + +\subsection{\code{anvil_palette_full}}{ + +An object of class \code{palettes_palette} with +1 colour palettes. +Use \code{names(anvil_palette_full)} to return all palette names. +} + +\subsection{\code{anvil_palette_contrast2}}{ + +An object of class \code{palettes_palette} with +1 contrasting colour palettes. +Use \code{names(anvil_palette_contrast2)} to return all palette names. +} + +\subsection{\code{anvil_palette_complement2}}{ + +An object of class \code{palettes_palette} with +1complementing colour palettes. +Use \code{names(anvil_palette_complement2)} to return all palette names. +} + +\subsection{\code{anvil_palette_single}}{ + +An object of class \code{palettes_palette} with +1 colour palettes. +Use \code{names(anvil_palette_single)} to return all palette names. +} +} +\source{ +\url{https://github.com/fhdsl/AnVILplot} +} +\usage{ +anvil_palettes + +anvil_palette_discrete + +anvil_palette_sequential + +anvil_palette_sequential_blues + +anvil_palette_diverging + +anvil_palette_full + +anvil_palette_contrast2 + +anvil_palette_complement2 + +anvil_palette_single +} +\description{ +Palettes inspired by the official colors of the AnVIL +} +\examples{ +# Get all palettes by name. +names(anvil_palettes) + +# Plot all palettes. +plot(anvil_palettes) +} +\seealso{ +\code{\link[=pal_palette]{pal_palette()}}, \code{\link[=pal_colour]{pal_colour()}} +} +\author{ +\href{https://github.com/kweav}{Kate Isaac} +} +\keyword{datasets}