-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update regional palette image shown in README
- Loading branch information
1 parent
5a89a1d
commit 6b3911a
Showing
11 changed files
with
31 additions
and
76 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,22 @@ | ||
<!-- README.md is generated from README.Rmd. Please edit README.Rmd --> | ||
|
||
|
||
|
||
# nmfspalette <a href={https:://nmfs-fish-tools.github.io/nmfspalette}><img src="man/figures/logo.png" align="right" width=139 height=139 alt="logo with an image of a fish in multiple palette colors" /> | ||
|
||
An R color palette for `{ggplot2}` using NOAA Fisheries branding colors | ||
|
||
[](https://github.com/nmfs-fish-tools/nmfspalette/actions/workflows/call-r-cmd-check.yml) | ||
|
||
------------------------------------------------------------------------ | ||
************** | ||
`{nmfspalette}` implements these [steps](https://drsimonj.svbtle.com/creating-corporate-colour-palettes-for-ggplot2) to create a `{ggplot2}` compatible palette according to [NOAA Fisheries branding](https://drive.google.com/drive/folders/1pcMRQHGdzX4NfsiDNTCYIBpRyP1-F57J)(NOAA internal only). | ||
|
||
`{nmfspalette}` implements these | ||
[steps](https://drsimonj.svbtle.com/creating-corporate-colour-palettes-for-ggplot2) | ||
to create a `{ggplot2}` compatible palette according to [NOAA Fisheries | ||
branding](https://drive.google.com/drive/folders/1pcMRQHGdzX4NfsiDNTCYIBpRyP1-F57J)(NOAA | ||
internal only). | ||
|
||
## Installation | ||
## Installation | ||
|
||
To install from GitHub use the following: | ||
|
||
``` r | ||
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: | ||
|
@@ -38,31 +26,24 @@ 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](https://github.com/nmfs-fish-tools/Resources/blob/main/CONTRIBUTING.md). | ||
|
||
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](https://github.com/nmfs-fish-tools/Resources/blob/main/CONTRIBUTING.md). | ||
|
||
## Usage | ||
|
||
To learn how to use `nmfspalette`, please check out the [interactive | ||
`learnr` tutorial](https://connect.fisheries.noaa.gov/colors/). | ||
## Usage | ||
To learn how to use `nmfspalette`, please check out the [interactive `learnr` tutorial](https://connect.fisheries.noaa.gov/colors/). | ||
|
||
Extract an interpolated color palette from the default “oceans” palette. | ||
Extract an interpolated color palette from the default "oceans" palette. | ||
|
||
You can change the number of colors (10 shown below). | ||
|
||
``` r | ||
nmfspalette::nmfs_palette("oceans")(10) | ||
#> [1] "#A6D4EC" "#78BEE2" "#4AA8D9" "#1C92CF" "#0072BB" "#004295" "#002B7B" | ||
#> [8] "#002467" "#001D55" "#001743" | ||
#> [1] "#A6D4EC" "#78BEE2" "#4AA8D9" "#1C92CF" | ||
#> [5] "#0072BB" "#004295" "#002B7B" "#002467" | ||
#> [9] "#001D55" "#001743" | ||
``` | ||
|
||
## Palettes | ||
|
||
To see the palettes, use the `display_nmfs_palette()` function. | ||
|
||
### oceans | ||
|
@@ -71,74 +52,69 @@ To see the palettes, use the `display_nmfs_palette()` function. | |
nmfspalette::display_nmfs_palette("oceans", 6) | ||
``` | ||
|
||
<!-- --> | ||
 | ||
|
||
### waves | ||
|
||
``` r | ||
nmfspalette::display_nmfs_palette("waves", 6) | ||
``` | ||
|
||
<!-- --> | ||
 | ||
|
||
### seagrass | ||
|
||
``` r | ||
nmfspalette::display_nmfs_palette("seagrass", 6) | ||
``` | ||
|
||
<!-- --> | ||
 | ||
|
||
### urchin | ||
|
||
``` r | ||
nmfspalette::display_nmfs_palette("urchin", 6) | ||
``` | ||
|
||
<!-- --> | ||
 | ||
|
||
### crustacean | ||
|
||
``` r | ||
nmfspalette::display_nmfs_palette("crustacean", 6) | ||
``` | ||
|
||
<!-- --> | ||
 | ||
|
||
### coral | ||
|
||
``` r | ||
nmfspalette::display_nmfs_palette("coral", 6) | ||
``` | ||
|
||
<!-- --> | ||
 | ||
|
||
### regional (discrete) | ||
|
||
``` r | ||
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](https://drive.google.com/drive/folders/1pcMRQHGdzX4NfsiDNTCYIBpRyP1-F57J)(NOAA | ||
internal only) for color names. Here, all spaces are removed in the | ||
color names. | ||
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](https://drive.google.com/drive/folders/1pcMRQHGdzX4NfsiDNTCYIBpRyP1-F57J)(NOAA internal only) for color names. Here, all spaces are removed in the color names. | ||
|
||
|
||
``` r | ||
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: | ||
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: | ||
|
||
|
||
``` r | ||
p <- ggplot(iris, aes(Sepal.Width, Sepal.Length, color = Species)) + | ||
|
@@ -147,41 +123,26 @@ p <- ggplot(iris, aes(Sepal.Width, Sepal.Length, color = Species)) + | |
p | ||
``` | ||
|
||
<!-- --> | ||
 | ||
|
||
`scale_fill_nmfs()` does not have a default and therefore requires a | ||
named argument, this is an example using the “crustacean” palette: | ||
`scale_fill_nmfs()` does not have a default and therefore requires a named argument, this is an example using the "crustacean" palette: | ||
|
||
``` r | ||
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.” | ||
|
||
------------------------------------------------------------------------ | ||
“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.” | ||
|
||
***** ******* | ||
<a href="https://www.fisheries.noaa.gov/"><img src="man/figures/noaa-fisheries-rgb-2line-horizontal-small.png" height=75 alt="NOAA Fisheries" /> | ||
|
||
[U.S. Department of Commerce](https://www.commerce.gov/) \| [National | ||
Oceanographic and Atmospheric Administration](https://www.noaa.gov) \| | ||
[NOAA Fisheries](https://www.fisheries.noaa.gov/) | ||
|
||
[U.S. Department of Commerce](https://www.commerce.gov/) | [National Oceanographic and Atmospheric Administration](https://www.noaa.gov) | [NOAA Fisheries](https://www.fisheries.noaa.gov/) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.