Skip to content

Latest commit

 

History

History
187 lines (132 loc) · 5.95 KB

README.md

File metadata and controls

187 lines (132 loc) · 5.95 KB

nmfspalette logo with an image of a fish in multiple palette colors

An R color palette for {ggplot2} using NOAA Fisheries branding colors

call-r-cmd-check


{nmfspalette} implements these steps to create a {ggplot2} compatible palette according to NOAA Fisheries branding(NOAA internal only).

Installation

To install from GitHub use the following:

remotes::install_github("nmfs-fish-tools/nmfspalette")
#> 
#> ── R CMD build ─────────────────────────────────────────────────────────────────
#> * checking for file ‘/tmp/Rtmppl2Bha/remotes76d23e0c443b/nmfs-fish-tools-nmfspalette-a43127b/DESCRIPTION’ ... OK
#> * preparing ‘nmfspalette’:
#> * checking DESCRIPTION meta-information ... OK
#> * checking for LF line-endings in source and make files and shell scripts
#> * checking for empty or unneeded directories
#> Omitted ‘LazyData’ from DESCRIPTION
#> * building ‘nmfspalette_0.0.0.9000.tar.gz’

To load the package, use:

library(nmfspalette)

Contributing

We welcome contributions to {nmfspalette}. You are welcome to make any changes you would like on a fork and submit a pull request. For more substantial changes or to create a branch, please contact [email protected] (NOAA Affiliates only). We ask that all contributors adhere to The NOAA Fisheries Integrated Toolbox code of conduct.

Usage

To learn how to use nmfspalette, please check out the interactive learnr tutorial.

Extract an interpolated color palette from the default “oceans” palette.

You can change the number of colors (10 shown below).

nmfspalette::nmfs_palette("oceans")(10)
#>  [1] "#A6D4EC" "#78BEE2" "#4AA8D9" "#1C92CF" "#0072BB" "#004295" "#002B7B"
#>  [8] "#002467" "#001D55" "#001743"

Palettes

To see the palettes, use the display_nmfs_palette() function.

oceans

nmfspalette::display_nmfs_palette("oceans", 6)

waves

nmfspalette::display_nmfs_palette("waves", 6)

seagrass

nmfspalette::display_nmfs_palette("seagrass", 6)

urchin

nmfspalette::display_nmfs_palette("urchin", 6)

crustacean

nmfspalette::display_nmfs_palette("crustacean", 6)

coral

nmfspalette::display_nmfs_palette("coral", 6)

regional (discrete)

nmfspalette::display_nmfs_palette("regional", 6)

Examples

In addition to nmfs_palette and display_nmfs_palette to get palettes, you can extract colors by name. Please see the NOAA Fisheries Branding guide(NOAA internal only) for color names. Here, all spaces are removed in the color names.

nmfspalette::nmfs_cols("processblue")
#> processblue 
#>   "#0085CA"

To use the palettes with {ggplot2}, the scale_color_nmfs() and scale_fill_nmfs() functions are provided. If no argument is given to scale_color_nmfs(), a default (“oceans”) is used:

p <- ggplot(iris, aes(Sepal.Width, Sepal.Length, color = Species)) +
  geom_point(size = 4) +
  scale_color_nmfs()
p

scale_fill_nmfs() does not have a default and therefore requires a named argument, this is an example using the “crustacean” palette:

ggplot(faithfuld, aes(waiting, eruptions)) +
  geom_raster(aes(fill = density)) +
  scale_fill_nmfs(palette = "crustacean", discrete = FALSE, reverse = TRUE)


Disclaimer

“The United States Department of Commerce (DOC) GitHub project code is provided on an ‘as is’ basis and the user assumes responsibility for its use. DOC has relinquished control of the information and no longer has responsibility to protect the integrity, confidentiality, or availability of the information. Any claims against the Department of Commerce stemming from the use of its GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.”


NOAA Fisheries

U.S. Department of Commerce | National Oceanographic and Atmospheric Administration | NOAA Fisheries