diff --git a/pkgdown.yml b/pkgdown.yml index 11f36ba..4c73d19 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.1.11 pkgdown: 2.1.0 pkgdown_sha: ~ articles: {} -last_built: 2024-07-17T03:45Z +last_built: 2024-07-17T04:06Z urls: reference: https://aagi-org-au-public.github.io/AAGIPalettes/reference article: https://aagi-org-au-public.github.io/AAGIPalettes/articles diff --git a/reference/colour_as_hex.html b/reference/colour_as_hex.html index 6c8faf7..782cf22 100644 --- a/reference/colour_as_hex.html +++ b/reference/colour_as_hex.html @@ -39,7 +39,7 @@

Usage

colour_as_hex(
   name = c("AAGI Black", "AAGI Bright Green", "AAGI Blue", "AAGI Teal", "AAGI Green",
-    "AAGI Yellow", "AAGI Orange")
+    "AAGI Yellow", "AAGI Orange", "AAGI Grey")
 )
diff --git a/search.json b/search.json index ad8a52c..9a20f39 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 AAGIPalettes authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Adam H. Sparks. Author, maintainer.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Sparks (2024). AAGIPalettes: AAGI Colour Palettes. R package version 0.0.0.9000, https://aagi-org-au-public.github.io/AAGIPalettes/, https://github.com/AAGI-Org-AU-Public/AAGIPalettes.","code":"@Manual{, title = {AAGIPalettes: AAGI Colour Palettes}, author = {Adam H. Sparks}, year = {2024}, note = {R package version 0.0.0.9000, https://aagi-org-au-public.github.io/AAGIPalettes/}, url = {https://github.com/AAGI-Org-AU-Public/AAGIPalettes}, }"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/index.html","id":"aagipalettes-aagi-colours-for-r-","dir":"","previous_headings":"","what":"AAGI Colour Palettes","title":"AAGI Colour Palettes","text":"repository contains code R package {AAGIPalettes}, installed R session (local RStudio Server), provides helper functions, data palettes working AAGI colours.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/index.html","id":"installation-instructions","dir":"","previous_headings":"","what":"Installation instructions","title":"AAGI Colour Palettes","text":"can install {AAGIPalettes} like :","code":"if (!requireNamespace(\"remotes\", quietly = TRUE)) { install.packages(\"remotes\") } remotes::install_github(\"AAGI-Org-AU-Public/AAGIPalettes\", dependencies = TRUE )"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/index.html","id":"quick-start","dir":"","previous_headings":"","what":"Quick start","title":"AAGI Colour Palettes","text":"Following quick examples {AAGIPalettes} functionality.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/index.html","id":"official-colours","dir":"","previous_headings":"Quick start","what":"Official Colours","title":"AAGI Colour Palettes","text":"{AAGIPalette} provides data object official AAGI colours comms guide. can see hex code values named vector like .","code":"library(\"AAGIPalettes\") aagi_colours #> AAGI Bright Green AAGI Teal AAGI Blue AAGI Green #> \"#B6D438\" \"#00808b\" \"#648FD2\" \"#54921E\" #> AAGI Yellow AAGI Orange AAGI Black AAGI Grey #> \"#FFBC42\" \"#ec8525\" \"#414042\" \"#F2F2F2\""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/index.html","id":"viewing-colours","dir":"","previous_headings":"Quick start","what":"Viewing Colours","title":"AAGI Colour Palettes","text":"{AAGIPalette} provides limited functionality viewing working colours. can plot colours palettes package follows. Display “aagi_BuOr” palette 9 stops.","code":"display_aagi_cols(\"aagi_colours\") display_aagi_cols(name = \"aagi_BuOr\", n = 9)"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/index.html","id":"interpolating-colours","dir":"","previous_headings":"Quick start","what":"Interpolating Colours","title":"AAGI Colour Palettes","text":"","code":"library(ggplot2) x <- interpolate_aagi_colours() # round the weights to clean up the legend, this is just an e.g. after all... wt_vals <- x(length(unique(round(mtcars$wt, 1)))) ggplot(mtcars, aes(x = mpg, y = hp, colour = as.factor(round(wt, 1)))) + geom_point() + scale_colour_manual(\"Weight\", values = wt_vals)"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/AAGIPalettes-package.html","id":null,"dir":"Reference","previous_headings":"","what":"AAGIPalettes: AAGI Colour Palettes — AAGIPalettes-package","title":"AAGIPalettes: AAGI Colour Palettes — AAGIPalettes-package","text":"Colour palettes based official Analytics Australian Grains Industry ('AAGI') comms guide others designed work harmoniously official 'AAGI' colours colour vision deficient (CVD) friendly.","code":""},{"path":[]},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/AAGIPalettes-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"AAGIPalettes: AAGI Colour Palettes — AAGIPalettes-package","text":"Maintainer: Adam H. Sparks adamhsparks@gmail.com (ORCID)","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_colours.html","id":null,"dir":"Reference","previous_headings":"","what":"Official AAGI Colours From the AAGI Comms Guide — aagi_colours","title":"Official AAGI Colours From the AAGI Comms Guide — aagi_colours","text":"Vector official AAGI Colour Hex Codes. colour palettes provided via aagi_palettes() plotting purposes may considered \"official\" AAGI colours.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_colours.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Official AAGI Colours From the AAGI Comms Guide — aagi_colours","text":"","code":"aagi_colours"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_colours.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Official AAGI Colours From the AAGI Comms Guide — aagi_colours","text":"vector eight (8) colours hexadecimal values: AAGI Bright Green #B6D438 AAGI Teal #00808B AAGI Blue #648FD2 AAGI Green #54921E AAGI Yellow #FFBC42 AAGI Orange #ec8525 AAGI Black #414042 AAGI Grey #F2F2F2","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_palettes.html","id":null,"dir":"Reference","previous_headings":"","what":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","title":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","text":"AAGI palettes use charts plots based official AAGI colours interpolated provide colours use maps graphical outputs. palettes intended colour-blind friendly, still based include official AAGI colours official AAGI colours. palettes intended useful creating plots incorporate come official AAGI colours may official AAGI colours.","code":""},{"path":[]},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_palettes.html","id":"diverging-palettes","dir":"Reference","previous_headings":"","what":"Diverging palettes","title":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","text":"\"aagi_BrYl\" (11 stops), \"aagi_BuOr\" (11 stops), \"aagi_BuYl\" (11 stops), \"aagi_GnYl\" (11 stops), \"aagi_RdBu\" (11 stops), \"aagi_RdTl\" (11 stops), \"aagi_RdYl\" (11 stops), \"aagi_TlGn\" (11 stops), \"aagi_TlYl\" (11 stops), \"aagi_TlGnYl\" (11 stops)","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_palettes.html","id":"sequential-palettes","dir":"Reference","previous_headings":"","what":"Sequential palettes","title":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","text":"\"aagi_blues\" (7 stops), \"aagi_bright_greens\" (7 stops), \"aagi_greens\" (11 stops), \"aagi_greys\" (9 stops), \"aagi_oranges\" (9 stops), \"aagi_reds\" (9 stops), \"aagi_teals\" (9 stops), \"aagi_yellows\" (7 stops)","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_palettes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","text":"","code":"aagi_palettes( n, name = c(\"aagi_BrYl\", \"aagi_BuOr\", \"aagi_BuYl\", \"aagi_GnYl\", \"aagi_RdBu\", \"aagi_RdTl\", \"aagi_RdYl\", \"aagi_TlGn\", \"aagi_TlYl\", \"aagi_TlGnYl\", \"aagi_blues\", \"aagi_bright_greens\", \"aagi_greens\", \"aagi_greys\", \"aagi_reds\", \"aagi_teals\", \"aagi_oranges\", \"aagi_yellows\"), direction = 1L )"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_palettes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","text":"n Integer Number different colours palette. See details . name Character string value name desired palette. direction Integer Sets order colours scale. 1, default order used. -1, order colours reversed.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_palettes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","text":"vector hexadecimal colour codes","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_palettes.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","text":"colours taken AAGI communications style guide colour palette. cases, e.g., aagi_red, #8b0b00 value, exist official palette generated taking complimentary colour aagi_teal, #00808b value. darkest lightest values used interpolating colours selected \"Tint Colour Variation\" list website, https://www.colorhexa.com/c5856d, using AAGI hexadecimal colour code input. interpolated values generated using http://www.vis4.net/palettes/, ensuring palettes colourblind safe. name palette, minimum value n 3 maximum vary 7 9 11 stops based palette requested.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_palettes.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","text":"","code":"# sequential blues with 7 stops aagi_palettes(n = 7, name = \"aagi_blues\", direction = 1) #> [1] \"#648fd2\" \"#81a0da\" \"#9bb2e1\" \"#b4c4e8\" \"#ccd7f0\" \"#e4eaf7\" \"#fcfdfe\" # diverging red teal colours with 11 stops aagi_palettes(n = 11, name = \"aagi_RdTl\", direction = 1) #> [1] \"#8b0b00\" \"#a8432d\" \"#c36d59\" \"#da9788\" \"#eec2b9\" \"#ffeeed\" \"#c6e4e7\" #> [8] \"#9ecacf\" \"#76b1b8\" \"#4b98a1\" \"#00808b\""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/colour_as_hex.html","id":null,"dir":"Reference","previous_headings":"","what":"Extract AAGI Colours as Hex Codes From Names — colour_as_hex","title":"Extract AAGI Colours as Hex Codes From Names — colour_as_hex","text":"Use plain English colour names AAGI colours get hex codes.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/colour_as_hex.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Extract AAGI Colours as Hex Codes From Names — colour_as_hex","text":"","code":"colour_as_hex( name = c(\"AAGI Black\", \"AAGI Bright Green\", \"AAGI Blue\", \"AAGI Teal\", \"AAGI Green\", \"AAGI Yellow\", \"AAGI Orange\") )"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/colour_as_hex.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Extract AAGI Colours as Hex Codes From Names — colour_as_hex","text":"name Character names AAGI colours. Multiple values allowed.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/colour_as_hex.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Extract AAGI Colours as Hex Codes From Names — colour_as_hex","text":"","code":"# return AAGI Black as a hex code colour_as_hex(name = \"AAGI Black\") #> [1] \"#414042\" # return AAGI Black, Bright Green and Orange as hex codes colour_as_hex(name = c(\"AAGI Black\", \"AAGI Bright Green\", \"AAGI Orange\")) #> [1] \"#414042\" \"#B6D438\" \"#ec8525\""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/display_aagi_cols.html","id":null,"dir":"Reference","previous_headings":"","what":"AAGI Palette Plots — display_aagi_cols","title":"AAGI Palette Plots — display_aagi_cols","text":"quick dirty way show AAGI colours palette plot.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/display_aagi_cols.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"AAGI Palette Plots — display_aagi_cols","text":"","code":"display_aagi_cols(name, n = NULL)"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/display_aagi_cols.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"AAGI Palette Plots — display_aagi_cols","text":"name either aagi_colours palette name lists . n Numeric Number different colours palette, minimum 3, maximum depends palette. Defaults 5. Ignored name aagi_colours. two (2) types palettes provided, sequential diverging. Sequential palettes suited ordered data progress low high. Lightness steps dominate look schemes, light colours low data values dark colours high data values. Diverging palettes put equal emphasis mid-range critical values extremes ends data range. critical class break middle legend emphasized light colours low high extremes emphasized dark colours contrasting hues. sequential palettes names : “aagi_blues”, “aagi_bright_greens”, “aagi_BrYl”, “aagi_greens”, “aagi_greys”, “aagi_reds”, “aagi_oranges”, “aagi_RdYl”, “aagi_teals”, “aagi_TlGnYl”, “aagi_TlYl”, “aagi_yellows” sequential palettes available variations 3 different values 11 different values. diverging palettes : “aagi_BuOr”, “aagi_BuYl”, “aagi_GnYl”, “aagi_RdBu”, “aagi_RdTl”, “aagi_TlGn” diverging palettes available variations 3 different values 11 different values. qualitative palettes, lowest number distinct values available always 3, largest number different different palettes. given together palette names following table.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/display_aagi_cols.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"AAGI Palette Plots — display_aagi_cols","text":"NULL. Called side-effects, plot given palette.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/display_aagi_cols.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"AAGI Palette Plots — display_aagi_cols","text":"","code":"# display the official AAGI colours display_aagi_cols(name = \"aagi_colours\") # display five colours from the Blue Orange diverging palette display_aagi_cols(name = \"aagi_BuOr\")"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/interpolate_aagi_colours.html","id":null,"dir":"Reference","previous_headings":"","what":"Interpolate an AAGI Colour Palette to Expand the Colour Values — interpolate_aagi_colours","title":"Interpolate an AAGI Colour Palette to Expand the Colour Values — interpolate_aagi_colours","text":"Takes AAGI colour palette generates colours , enough make chart. interpolation method set spline (default linear) attempt reduce number vomit colours get produced generating many colours.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/interpolate_aagi_colours.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Interpolate an AAGI Colour Palette to Expand the Colour Values — interpolate_aagi_colours","text":"","code":"interpolate_aagi_colours( colours = c(\"AAGI Orange\", \"AAGI Yellow\", \"AAGI Bright Green\", \"AAGI Green\", \"AAGI Teal\", \"AAGI Blue\"), direction = 1, ... )"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/interpolate_aagi_colours.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Interpolate an AAGI Colour Palette to Expand the Colour Values — interpolate_aagi_colours","text":"colours (Character; given names AAGI colours use interpolation. Defaults \"AAGI Orange\", \"AAGI Yellow\", \"AAGI Bright Green\", \"AAGI Teal\", \"AAGI Blue\" order. direction Integer Sets order colours scale. 1, default order used. -1, order colours reversed. ... Additional arguments pass grDevices::colorRampPalette(), see details grDevices::colorRamp().","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/interpolate_aagi_colours.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Interpolate an AAGI Colour Palette to Expand the Colour Values — interpolate_aagi_colours","text":"function takes single value makes many colours.","code":""},{"path":[]},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/interpolate_aagi_colours.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Interpolate an AAGI Colour Palette to Expand the Colour Values — interpolate_aagi_colours","text":"","code":"library(ggplot2) x <- interpolate_aagi_colours() # round the weights to clean up the legend, this is just an e.g. after all... wt_vals <- x(length(unique(round(mtcars$wt, 1)))) ggplot(mtcars, aes(x = mpg, y = hp, colour = as.factor(round(wt, 1)))) + geom_point() + scale_colour_manual(\"Weight\", values = wt_vals)"}] +[{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 AAGIPalettes authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Adam H. Sparks. Author, maintainer.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Sparks (2024). AAGIPalettes: AAGI Colour Palettes. R package version 0.0.0.9000, https://aagi-org-au-public.github.io/AAGIPalettes/, https://github.com/AAGI-Org-AU-Public/AAGIPalettes.","code":"@Manual{, title = {AAGIPalettes: AAGI Colour Palettes}, author = {Adam H. Sparks}, year = {2024}, note = {R package version 0.0.0.9000, https://aagi-org-au-public.github.io/AAGIPalettes/}, url = {https://github.com/AAGI-Org-AU-Public/AAGIPalettes}, }"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/index.html","id":"aagipalettes-aagi-colours-for-r-","dir":"","previous_headings":"","what":"AAGI Colour Palettes","title":"AAGI Colour Palettes","text":"repository contains code R package {AAGIPalettes}, installed R session (local RStudio Server), provides helper functions, data palettes working AAGI colours.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/index.html","id":"installation-instructions","dir":"","previous_headings":"","what":"Installation instructions","title":"AAGI Colour Palettes","text":"can install {AAGIPalettes} like :","code":"if (!requireNamespace(\"remotes\", quietly = TRUE)) { install.packages(\"remotes\") } remotes::install_github(\"AAGI-Org-AU-Public/AAGIPalettes\", dependencies = TRUE )"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/index.html","id":"quick-start","dir":"","previous_headings":"","what":"Quick start","title":"AAGI Colour Palettes","text":"Following quick examples {AAGIPalettes} functionality.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/index.html","id":"official-colours","dir":"","previous_headings":"Quick start","what":"Official Colours","title":"AAGI Colour Palettes","text":"{AAGIPalette} provides data object official AAGI colours comms guide. can see hex code values named vector like .","code":"library(\"AAGIPalettes\") aagi_colours #> AAGI Bright Green AAGI Teal AAGI Blue AAGI Green #> \"#B6D438\" \"#00808b\" \"#648FD2\" \"#54921E\" #> AAGI Yellow AAGI Orange AAGI Black AAGI Grey #> \"#FFBC42\" \"#ec8525\" \"#414042\" \"#F2F2F2\""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/index.html","id":"viewing-colours","dir":"","previous_headings":"Quick start","what":"Viewing Colours","title":"AAGI Colour Palettes","text":"{AAGIPalette} provides limited functionality viewing working colours. can plot colours palettes package follows. Display “aagi_BuOr” palette 9 stops.","code":"display_aagi_cols(\"aagi_colours\") display_aagi_cols(name = \"aagi_BuOr\", n = 9)"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/index.html","id":"interpolating-colours","dir":"","previous_headings":"Quick start","what":"Interpolating Colours","title":"AAGI Colour Palettes","text":"","code":"library(ggplot2) x <- interpolate_aagi_colours() # round the weights to clean up the legend, this is just an e.g. after all... wt_vals <- x(length(unique(round(mtcars$wt, 1)))) ggplot(mtcars, aes(x = mpg, y = hp, colour = as.factor(round(wt, 1)))) + geom_point() + scale_colour_manual(\"Weight\", values = wt_vals)"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/AAGIPalettes-package.html","id":null,"dir":"Reference","previous_headings":"","what":"AAGIPalettes: AAGI Colour Palettes — AAGIPalettes-package","title":"AAGIPalettes: AAGI Colour Palettes — AAGIPalettes-package","text":"Colour palettes based official Analytics Australian Grains Industry ('AAGI') comms guide others designed work harmoniously official 'AAGI' colours colour vision deficient (CVD) friendly.","code":""},{"path":[]},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/AAGIPalettes-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"AAGIPalettes: AAGI Colour Palettes — AAGIPalettes-package","text":"Maintainer: Adam H. Sparks adamhsparks@gmail.com (ORCID)","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_colours.html","id":null,"dir":"Reference","previous_headings":"","what":"Official AAGI Colours From the AAGI Comms Guide — aagi_colours","title":"Official AAGI Colours From the AAGI Comms Guide — aagi_colours","text":"Vector official AAGI Colour Hex Codes. colour palettes provided via aagi_palettes() plotting purposes may considered \"official\" AAGI colours.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_colours.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Official AAGI Colours From the AAGI Comms Guide — aagi_colours","text":"","code":"aagi_colours"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_colours.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Official AAGI Colours From the AAGI Comms Guide — aagi_colours","text":"vector eight (8) colours hexadecimal values: AAGI Bright Green #B6D438 AAGI Teal #00808B AAGI Blue #648FD2 AAGI Green #54921E AAGI Yellow #FFBC42 AAGI Orange #ec8525 AAGI Black #414042 AAGI Grey #F2F2F2","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_palettes.html","id":null,"dir":"Reference","previous_headings":"","what":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","title":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","text":"AAGI palettes use charts plots based official AAGI colours interpolated provide colours use maps graphical outputs. palettes intended colour-blind friendly, still based include official AAGI colours official AAGI colours. palettes intended useful creating plots incorporate come official AAGI colours may official AAGI colours.","code":""},{"path":[]},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_palettes.html","id":"diverging-palettes","dir":"Reference","previous_headings":"","what":"Diverging palettes","title":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","text":"\"aagi_BrYl\" (11 stops), \"aagi_BuOr\" (11 stops), \"aagi_BuYl\" (11 stops), \"aagi_GnYl\" (11 stops), \"aagi_RdBu\" (11 stops), \"aagi_RdTl\" (11 stops), \"aagi_RdYl\" (11 stops), \"aagi_TlGn\" (11 stops), \"aagi_TlYl\" (11 stops), \"aagi_TlGnYl\" (11 stops)","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_palettes.html","id":"sequential-palettes","dir":"Reference","previous_headings":"","what":"Sequential palettes","title":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","text":"\"aagi_blues\" (7 stops), \"aagi_bright_greens\" (7 stops), \"aagi_greens\" (11 stops), \"aagi_greys\" (9 stops), \"aagi_oranges\" (9 stops), \"aagi_reds\" (9 stops), \"aagi_teals\" (9 stops), \"aagi_yellows\" (7 stops)","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_palettes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","text":"","code":"aagi_palettes( n, name = c(\"aagi_BrYl\", \"aagi_BuOr\", \"aagi_BuYl\", \"aagi_GnYl\", \"aagi_RdBu\", \"aagi_RdTl\", \"aagi_RdYl\", \"aagi_TlGn\", \"aagi_TlYl\", \"aagi_TlGnYl\", \"aagi_blues\", \"aagi_bright_greens\", \"aagi_greens\", \"aagi_greys\", \"aagi_reds\", \"aagi_teals\", \"aagi_oranges\", \"aagi_yellows\"), direction = 1L )"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_palettes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","text":"n Integer Number different colours palette. See details . name Character string value name desired palette. direction Integer Sets order colours scale. 1, default order used. -1, order colours reversed.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_palettes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","text":"vector hexadecimal colour codes","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_palettes.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","text":"colours taken AAGI communications style guide colour palette. cases, e.g., aagi_red, #8b0b00 value, exist official palette generated taking complimentary colour aagi_teal, #00808b value. darkest lightest values used interpolating colours selected \"Tint Colour Variation\" list website, https://www.colorhexa.com/c5856d, using AAGI hexadecimal colour code input. interpolated values generated using http://www.vis4.net/palettes/, ensuring palettes colourblind safe. name palette, minimum value n 3 maximum vary 7 9 11 stops based palette requested.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/aagi_palettes.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Sequential and Diverging Colour Palettes for AAGI Graphical Outputs — aagi_palettes","text":"","code":"# sequential blues with 7 stops aagi_palettes(n = 7, name = \"aagi_blues\", direction = 1) #> [1] \"#648fd2\" \"#81a0da\" \"#9bb2e1\" \"#b4c4e8\" \"#ccd7f0\" \"#e4eaf7\" \"#fcfdfe\" # diverging red teal colours with 11 stops aagi_palettes(n = 11, name = \"aagi_RdTl\", direction = 1) #> [1] \"#8b0b00\" \"#a8432d\" \"#c36d59\" \"#da9788\" \"#eec2b9\" \"#ffeeed\" \"#c6e4e7\" #> [8] \"#9ecacf\" \"#76b1b8\" \"#4b98a1\" \"#00808b\""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/colour_as_hex.html","id":null,"dir":"Reference","previous_headings":"","what":"Extract AAGI Colours as Hex Codes From Names — colour_as_hex","title":"Extract AAGI Colours as Hex Codes From Names — colour_as_hex","text":"Use plain English colour names AAGI colours get hex codes.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/colour_as_hex.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Extract AAGI Colours as Hex Codes From Names — colour_as_hex","text":"","code":"colour_as_hex( name = c(\"AAGI Black\", \"AAGI Bright Green\", \"AAGI Blue\", \"AAGI Teal\", \"AAGI Green\", \"AAGI Yellow\", \"AAGI Orange\", \"AAGI Grey\") )"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/colour_as_hex.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Extract AAGI Colours as Hex Codes From Names — colour_as_hex","text":"name Character names AAGI colours. Multiple values allowed.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/colour_as_hex.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Extract AAGI Colours as Hex Codes From Names — colour_as_hex","text":"","code":"# return AAGI Black as a hex code colour_as_hex(name = \"AAGI Black\") #> [1] \"#414042\" # return AAGI Black, Bright Green and Orange as hex codes colour_as_hex(name = c(\"AAGI Black\", \"AAGI Bright Green\", \"AAGI Orange\")) #> [1] \"#414042\" \"#B6D438\" \"#ec8525\""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/display_aagi_cols.html","id":null,"dir":"Reference","previous_headings":"","what":"AAGI Palette Plots — display_aagi_cols","title":"AAGI Palette Plots — display_aagi_cols","text":"quick dirty way show AAGI colours palette plot.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/display_aagi_cols.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"AAGI Palette Plots — display_aagi_cols","text":"","code":"display_aagi_cols(name, n = NULL)"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/display_aagi_cols.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"AAGI Palette Plots — display_aagi_cols","text":"name either aagi_colours palette name lists . n Numeric Number different colours palette, minimum 3, maximum depends palette. Defaults 5. Ignored name aagi_colours. two (2) types palettes provided, sequential diverging. Sequential palettes suited ordered data progress low high. Lightness steps dominate look schemes, light colours low data values dark colours high data values. Diverging palettes put equal emphasis mid-range critical values extremes ends data range. critical class break middle legend emphasized light colours low high extremes emphasized dark colours contrasting hues. sequential palettes names : “aagi_blues”, “aagi_bright_greens”, “aagi_BrYl”, “aagi_greens”, “aagi_greys”, “aagi_reds”, “aagi_oranges”, “aagi_RdYl”, “aagi_teals”, “aagi_TlGnYl”, “aagi_TlYl”, “aagi_yellows” sequential palettes available variations 3 different values 11 different values. diverging palettes : “aagi_BuOr”, “aagi_BuYl”, “aagi_GnYl”, “aagi_RdBu”, “aagi_RdTl”, “aagi_TlGn” diverging palettes available variations 3 different values 11 different values. qualitative palettes, lowest number distinct values available always 3, largest number different different palettes. given together palette names following table.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/display_aagi_cols.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"AAGI Palette Plots — display_aagi_cols","text":"NULL. Called side-effects, plot given palette.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/display_aagi_cols.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"AAGI Palette Plots — display_aagi_cols","text":"","code":"# display the official AAGI colours display_aagi_cols(name = \"aagi_colours\") # display five colours from the Blue Orange diverging palette display_aagi_cols(name = \"aagi_BuOr\")"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/interpolate_aagi_colours.html","id":null,"dir":"Reference","previous_headings":"","what":"Interpolate an AAGI Colour Palette to Expand the Colour Values — interpolate_aagi_colours","title":"Interpolate an AAGI Colour Palette to Expand the Colour Values — interpolate_aagi_colours","text":"Takes AAGI colour palette generates colours , enough make chart. interpolation method set spline (default linear) attempt reduce number vomit colours get produced generating many colours.","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/interpolate_aagi_colours.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Interpolate an AAGI Colour Palette to Expand the Colour Values — interpolate_aagi_colours","text":"","code":"interpolate_aagi_colours( colours = c(\"AAGI Orange\", \"AAGI Yellow\", \"AAGI Bright Green\", \"AAGI Green\", \"AAGI Teal\", \"AAGI Blue\"), direction = 1, ... )"},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/interpolate_aagi_colours.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Interpolate an AAGI Colour Palette to Expand the Colour Values — interpolate_aagi_colours","text":"colours (Character; given names AAGI colours use interpolation. Defaults \"AAGI Orange\", \"AAGI Yellow\", \"AAGI Bright Green\", \"AAGI Teal\", \"AAGI Blue\" order. direction Integer Sets order colours scale. 1, default order used. -1, order colours reversed. ... Additional arguments pass grDevices::colorRampPalette(), see details grDevices::colorRamp().","code":""},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/interpolate_aagi_colours.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Interpolate an AAGI Colour Palette to Expand the Colour Values — interpolate_aagi_colours","text":"function takes single value makes many colours.","code":""},{"path":[]},{"path":"https://aagi-org-au-public.github.io/AAGIPalettes/reference/interpolate_aagi_colours.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Interpolate an AAGI Colour Palette to Expand the Colour Values — interpolate_aagi_colours","text":"","code":"library(ggplot2) x <- interpolate_aagi_colours() # round the weights to clean up the legend, this is just an e.g. after all... wt_vals <- x(length(unique(round(mtcars$wt, 1)))) ggplot(mtcars, aes(x = mpg, y = hp, colour = as.factor(round(wt, 1)))) + geom_point() + scale_colour_manual(\"Weight\", values = wt_vals)"}]