From 140984bb54572b89b1ed90e625365a987b926f52 Mon Sep 17 00:00:00 2001 From: Pascal Burkhard Date: Wed, 1 May 2024 12:12:51 +0200 Subject: [PATCH] Update documentation --- DESCRIPTION | 4 +- R/fonts.R | 4 ++ R/ggplot_scales.R | 78 ++++++++++++++++++++++++++ R/{plot_save.R => ggplot_utils.R} | 66 ++++++++++++++++++++-- R/gis.R | 13 +++-- R/highcharter_themes.R | 43 ++++++++------ R/plot_utils.R | 41 -------------- R/scales.R | 59 ------------------- R/zzz.R | 1 + _pkgdown.yml | 8 --- docs/pkgdown.yml | 2 +- docs/reference/ggeo-package.html | 9 ++- docs/reference/ggeo_coord.html | 19 ++++--- docs/reference/ggeo_label_sci_10.html | 31 ++++++++-- docs/reference/ggeo_remove_breaks.html | 29 ++++++++-- docs/reference/ggeo_save.html | 56 +++++++++++++++--- docs/reference/hc_purple_theme.html | 54 ++++++++++++++---- docs/reference/index.html | 54 ++---------------- docs/search.json | 2 +- man/ggeo-package.Rd | 2 + man/ggeo_capitalize_title.Rd | 2 +- man/ggeo_coord.Rd | 12 ++-- man/ggeo_file.Rd | 1 + man/ggeo_install_fonts_linux.Rd | 1 + man/ggeo_install_fonts_macos.Rd | 1 + man/ggeo_label_abs_percent.Rd | 17 ------ man/ggeo_label_pyramid.Rd | 17 ------ man/ggeo_label_sci_10.Rd | 28 +++++++-- man/ggeo_remove_breaks.Rd | 20 +++++-- man/ggeo_remove_title.Rd | 2 +- man/ggeo_save.Rd | 44 ++++++++++++--- man/ggeoformat_pyramid_pop.Rd | 2 +- man/ggeosave.Rd | 2 +- man/hc_purple_theme.Rd | 37 ++++++++++-- man/hc_samarqand_theme.Rd | 19 ------- man/hc_web_theme.Rd | 19 ------- 36 files changed, 467 insertions(+), 332 deletions(-) create mode 100644 R/ggplot_scales.R rename R/{plot_save.R => ggplot_utils.R} (52%) delete mode 100644 R/plot_utils.R delete mode 100644 R/scales.R delete mode 100644 man/ggeo_label_abs_percent.Rd delete mode 100644 man/ggeo_label_pyramid.Rd delete mode 100644 man/hc_samarqand_theme.Rd delete mode 100644 man/hc_web_theme.Rd diff --git a/DESCRIPTION b/DESCRIPTION index 6b892e3..9945afd 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -23,14 +23,14 @@ Imports: magrittr, methods, purrr, + preferably, rlang, scales, showtext, stringr, sysfonts, utils, - wesanderson, - preferably + wesanderson Remotes: Nenuial/geotools Depends: diff --git a/R/fonts.R b/R/fonts.R index 6adac8e..2221987 100644 --- a/R/fonts.R +++ b/R/fonts.R @@ -3,7 +3,9 @@ #' @param system_wide Install the fonts for all users? #' #' @return Move fonts to MacOS font folder +#' @keywords internal #' @export +#' ggeo_install_fonts_macos <- function(system_wide = FALSE) { new_font_path <- "~/Library/Fonts/" if (system_wide) new_font_path <- "/Library/Fonts/" @@ -22,6 +24,8 @@ ggeo_install_fonts_macos <- function(system_wide = FALSE) { #' #' @return Move fonts to Linux font folders #' @export +#' @keywords internal +#' ggeo_install_fonts_linux <- function() { fs::dir_ls(path = ggeo_file("fonts/")) |> purrr::walk( diff --git a/R/ggplot_scales.R b/R/ggplot_scales.R new file mode 100644 index 0000000..8978af9 --- /dev/null +++ b/R/ggplot_scales.R @@ -0,0 +1,78 @@ +#' Format labels +#' +#' These functions extend the {[scales](https://scales.r-lib.org)} +#' package and allow formatting labels. +#' +#' @details +#' [`ggeo_label_sci_10()`] is used to format numbers with a clean +#' scientific format using a multiplier and not the *ugly* notation +#' using the letter *e*. +#' +#' [`ggeo_label_pyramid()`] is used for population pyramids with +#' absolute numbers. It formats the absolute number using +#' [`ggeo_label_sci_10()`]. +#' +#' [`ggeo_label_abs_percent()`] is also used for population pyramids +#' but with relative numbers (percents). It uses [`scales::percent()`] +#' and absolute numbers. +#' +#' @param x Number to format +#' +#' @return A formatted string for the scales +#' @export +ggeo_label_sci_10 <- function(x) { + parse(text = gsub("e\\+?", "%.%10^", scales::scientific_format()(x))) +} + +#' @rdname ggeo_label_sci_10 +#' @export +ggeo_label_pyramid <- function(x) { + ggeo_label_sci_10(abs(x)) +} + +#' @rdname ggeo_label_sci_10 +#' @export +ggeo_label_abs_percent <- function(x) { + scales::percent(abs(x), accuracy = 0.1) +} + +#' Format population labels on pyramids +#' +#' `r lifecycle::badge("deprecated")` +#' +#' @param x The label +#' @param ... For compatibility +#' +#' @return Absolute +#' @export +#' @keywords internal +ggeoformat_pyramid_pop <- function(x, ...) { + scales::number(abs(x), scale = 1e-3) +} + +#' Remove specific breaks +#' +#' This function can be used to modify the breaks of a ggplot2 +#' scale. It is specifically designed to remove the some breaks +#' in the scale. +#' +#' @param original_func The function to create the breaks. +#' Use the break functions from the {[scales](https://scales.r-lib.org)} +#' @param remove_list The values to remove from the scale. +#' +#' @return A list +#' @export +#' @examples +#' ggplot2::ggplot(ggplot2::aes(x = speed, y = dist), data = cars) + +#' ggplot2::geom_point() + +#' ggplot2::labs(title = "Fast cars!") + +#' ggplot2::scale_y_continuous( +#' breaks = ggeo::ggeo_remove_breaks(scales::breaks_pretty(6), list(0)), +#' ) +#' +ggeo_remove_breaks <- function(original_func, remove_list = list()) { + function(x) { + original_result <- original_func(x) + original_result[!(original_result %in% remove_list)] + } +} diff --git a/R/plot_save.R b/R/ggplot_utils.R similarity index 52% rename from R/plot_save.R rename to R/ggplot_utils.R index fa10677..4889b29 100644 --- a/R/plot_save.R +++ b/R/ggplot_utils.R @@ -48,15 +48,26 @@ ggeosave <- function(filename, ..., #' Save function #' -#' @param plot The ggplot2 object to save (should by piped in ;) +#' @param plot The ggplot2 object to save (should be piped in ;) #' @param filename Path for filename (with extension!) -#' @param width Width. Defaults to keynote width (full = geotools::gtl_options("plot_full_width")) -#' @param height Height. Defaults to keynote height (full = geotools::gtl_options("plot_full_width")) -#' @param dpi DPI. Defaults to 72. -#' @param units Units. Defaults to cm. -#' @param ... Arguments to pass to ggplot2::ggsave +#' @param width The plot width. +#' Defaults to keynote width (`geotools::gtl_options("plot_standard_width")`). +#' For full slide width use `geotools::gtl_options("plot_full_width")`. +#' @param height The plot height. +#' Defaults to keynote height (`geotools::gtl_options("plot_standard_height")`). +#' For full slide height use `geotools::gtl_options("plot_full_height")`. +#' @param dpi The DPI. Default is 72. +#' @param units Units. Default is cm. +#' @inheritDotParams ggplot2::ggsave device scale limitsize bg create.dir #' #' @export +#' @examplesIf interactive() +#' cars |> +#' ggplot2::ggplot(ggplot2::aes(x = speed, y = dist)) + +#' ggplot2::geom_point() -> simple_plot +#' +#' ggeo_save(simple_plot, "simple_plot.png") +#' ggeo_save <- function(plot, filename, width = geotools::gtl_options("plot_standard_width"), @@ -75,3 +86,46 @@ ggeo_save <- function(plot, ... ) } + + +#' Copitalize plot title +#' +#' @param plot A ggplot2 object +#' +#' @return A ggplot2 object +#' @export +#' @examplesIf interactive() +#' ggplot(aes(x = speed, y = dist), data = cars) + +#' geom_point() + +#' labs(title = "Fast cars !") + +#' ggeo_remove_title() +#' +ggeo_capitalize_title <- function(plot) { + plot$labels$title %>% + stringr::str_to_upper() %>% + stringr::str_replace_all("COLOR:#", "color:#") -> plot$labels$title + + plot$patches$annotation$title %>% + stringr::str_to_upper() %>% + stringr::str_replace("COLOR:#", "color:#") -> plot$patches$annotation$title + + plot +} + +#' Remove plot title +#' +#' @param plot A ggplot2 object +#' +#' @return A ggplot2 object +#' @export +#' @examplesIf interactive() +#' ggplot(aes(x = speed, y = dist), data = cars) + +#' geom_point() + +#' labs(title = "Fast cars !") + +#' ggeo_remove_title() +#' +ggeo_remove_title <- function(plot) { + plot$labels$title <- NULL + plot$patches$annotation$title <- NULL + plot +} diff --git a/R/gis.R b/R/gis.R index 202ba53..061311f 100644 --- a/R/gis.R +++ b/R/gis.R @@ -6,16 +6,19 @@ #' #' @seealso [geotools::gtl_crs_proj()] #' -#' @param proj A string for the projection code +#' @inheritParams geotools::gtl_crs_proj #' @inheritDotParams ggplot2::coord_sf #' #' @return A ggplot2 coord object #' @export -#' @examplesIf interactive() -#' ggeo_coord("eqearth") +#' @examples +#' rnaturalearth::ne_countries() |> +#' ggplot2::ggplot() + +#' ggplot2::geom_sf() + +#' ggeo_coord("eqearth") #' -ggeo_coord <- function(proj, ...) { - crs <- geotools::gtl_crs_proj(proj) +ggeo_coord <- function(code, ...) { + crs <- geotools::gtl_crs_proj(code) ggplot2::coord_sf(crs = crs, datum = NA, ...) } diff --git a/R/highcharter_themes.R b/R/highcharter_themes.R index f5a61f0..7be96da 100644 --- a/R/highcharter_themes.R +++ b/R/highcharter_themes.R @@ -1,10 +1,31 @@ -#' Highchart Theme: Purple -#' Add a purple theme to a highchart +#' Highcharts themes #' -#' @param hc A highchart object +#' These functions can be used to modify the theme of +#' a highcharts plot. #' -#' @return A highchart object +#' @param hc A highcharts object +#' +#' @return A highcharts object #' @export +#' @examples +#' highcharter::hchart( +#' cars, "point", +#' highcharter::hcaes(x = speed, y = dist) +#' ) |> +#' hc_purple_theme() +#' +#' highcharter::hchart( +#' cars, "point", +#' highcharter::hcaes(x = speed, y = dist) +#' ) |> +#' hc_samarqand_theme() +#' +#' highcharter::hchart( +#' cars, "point", +#' highcharter::hcaes(x = speed, y = dist) +#' ) |> +#' hc_web_theme() +#' hc_purple_theme <- function(hc) { base_colors <- list( main_color = "#e0d9fb", @@ -86,12 +107,7 @@ hc_purple_theme <- function(hc) { highcharter::hc_add_theme(theme) } -#' Highchart Theme: Samarqand -#' Add a samarqand theme to a highchart -#' -#' @param hc A highchart object -#' -#' @return A highchart object +#' @rdname hc_purple_theme #' @export hc_samarqand_theme <- function(hc) { base_colors <- list( @@ -174,12 +190,7 @@ hc_samarqand_theme <- function(hc) { highcharter::hc_add_theme(theme) } -#' Highchart Theme: Web -#' Add a web theme to a highchart -#' -#' @param hc A highchart object -#' -#' @return A highchart object +#' @rdname hc_purple_theme #' @export hc_web_theme <- function(hc) { base_colors <- list( diff --git a/R/plot_utils.R b/R/plot_utils.R deleted file mode 100644 index e7ad275..0000000 --- a/R/plot_utils.R +++ /dev/null @@ -1,41 +0,0 @@ -#' Copitalize plot title -#' -#' @param plot A ggplot2 object -#' -#' @return A ggplot2 object -#' @export -#' @examplesIf interactive() -#' ggplot(aes(x = speed, y = dist), data = cars) + -#' geom_point() + -#' labs(title = "Fast cars !") + -#' ggeo_remove_title() -#' -ggeo_capitalize_title <- function(plot) { - plot$labels$title %>% - stringr::str_to_upper() %>% - stringr::str_replace_all("COLOR:#", "color:#") -> plot$labels$title - - plot$patches$annotation$title %>% - stringr::str_to_upper() %>% - stringr::str_replace("COLOR:#", "color:#") -> plot$patches$annotation$title - - plot -} - -#' Remove plot title -#' -#' @param plot A ggplot2 object -#' -#' @return A ggplot2 object -#' @export -#' @examplesIf interactive() -#' ggplot(aes(x = speed, y = dist), data = cars) + -#' geom_point() + -#' labs(title = "Fast cars !") + -#' ggeo_remove_title() -#' -ggeo_remove_title <- function(plot) { - plot$labels$title <- NULL - plot$patches$annotation$title <- NULL - plot -} diff --git a/R/scales.R b/R/scales.R deleted file mode 100644 index f72e97f..0000000 --- a/R/scales.R +++ /dev/null @@ -1,59 +0,0 @@ -#' Format labels using scientific notation -#' -#' @param x Number to format -#' -#' @return A formatted expression -#' @export -ggeo_label_sci_10 <- function(x) { - parse(text = gsub("e\\+?", "%.%10^", scales::scientific_format()(x))) -} - -#' Format labels for pyramids -#' -#' @param x Number to format -#' -#' @return A formatted expression -#' @export -ggeo_label_pyramid <- function(x) { - ggeo_label_sci_10(abs(x)) -} - -#' Format labels for relative pyramids -#' -#' @param x Number to format -#' -#' @return A formatted expression -#' @export -ggeo_label_abs_percent <- function(x) { - scales::percent(abs(x), accuracy = 0.1) -} - -#' Format population labels on pyramids -#' -#' `r lifecycle::badge("deprecated")` -#' -#' @param x The label -#' @param ... For compatibility -#' -#' @return Absolute -#' @export -#' @keywords internal -ggeoformat_pyramid_pop <- function(x, ...) { - scales::number(abs(x), scale = 1e-3) -} - - - -#' Remove specific breaks -#' -#' @param original_func The break function -#' @param remove_list The values to remove from the breaks -#' -#' @return A list -#' @export -ggeo_remove_breaks <- function(original_func, remove_list = list()) { - function(x) { - original_result <- original_func(x) - original_result[!(original_result %in% remove_list)] - } -} diff --git a/R/zzz.R b/R/zzz.R index 75687d5..75a0b61 100644 --- a/R/zzz.R +++ b/R/zzz.R @@ -4,6 +4,7 @@ #' #' @return A file path #' +#' @keywords internal #' @export ggeo_file = function(...) { system.file(..., package = 'ggeo', mustWork = TRUE) diff --git a/_pkgdown.yml b/_pkgdown.yml index 793c15c..1194b1d 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -38,11 +38,3 @@ reference: - ggeopal_chooser - ggeopal_hex_to_hcl - ggeopal_to_gradient - -- title: Utilities - description: | - Functions to assist package use. - contents: - - ggeo_file - - ggeo_install_fonts_linux - - ggeo_install_fonts_macos diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 1b7ba7b..0631b3d 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.1.1 pkgdown: 2.0.9 pkgdown_sha: ~ articles: {} -last_built: 2024-04-30T21:27Z +last_built: 2024-05-01T10:12Z urls: reference: https://ggeo.nenuial.org/reference article: https://ggeo.nenuial.org/articles diff --git a/docs/reference/ggeo-package.html b/docs/reference/ggeo-package.html index 7b1501b..fafcb7b 100644 --- a/docs/reference/ggeo-package.html +++ b/docs/reference/ggeo-package.html @@ -1,5 +1,6 @@ -ggeo: Provide Helpers and Themes for ggplot — ggeo-package • ggeo @@ -49,7 +51,8 @@
-

This package provides helper functions for ggplot graphs and maps.

+

+

This package provides helper functions for ggplot graphs and maps.

diff --git a/docs/reference/ggeo_coord.html b/docs/reference/ggeo_coord.html index 4fbd647..fbd152c 100644 --- a/docs/reference/ggeo_coord.html +++ b/docs/reference/ggeo_coord.html @@ -53,20 +53,20 @@
-

A function that uses geotools::gtl_crs_proj() to +

A function that uses geotools::gtl_crs_proj() to get the CRS configuration and applies it to a ggplot2 map.

Usage

- 
ggeo_coord(proj, ...)
+ 
ggeo_coord(code, ...)

Arguments

-
proj
-

A string for the projection code

+
code
+

A string with the CRS identifier

...
@@ -181,14 +181,17 @@

Value

See also

-

geotools::gtl_crs_proj()

+

geotools::gtl_crs_proj()

Examples

- 
if (FALSE) { # interactive()
-ggeo_coord("eqearth")
-}
+    
rnaturalearth::ne_countries() |>
+  ggplot2::ggplot() +
+  ggplot2::geom_sf() +
+  ggeo_coord("eqearth")
+
+
- - hc_samarqand_theme() -
-
Highchart Theme: Samarqand Add a samarqand theme to a highchart
-
- - hc_web_theme() -
-
Highchart Theme: Web Add a web theme to a highchart
+
Highcharts themes

ggplot2 helper functions

@@ -100,19 +90,9 @@

ggplot2 helper functionsReturn sf coord for given CRS code
- ggeo_label_abs_percent() + ggeo_label_sci_10() ggeo_label_pyramid() ggeo_label_abs_percent()
-
Format labels for relative pyramids
-
- - ggeo_label_pyramid() -
-
Format labels for pyramids
-
- - ggeo_label_sci_10() -
-
Format labels using scientific notation
+
Format labels
ggeo_remove_breaks() @@ -159,32 +139,6 @@

Color palettesggeopal_to_gradient()

Create gradient for palette colors
-

-

Utilities

- -

Functions to assist package use.

- - -
- - - - -
- - ggeo_file() -
-
A shortcut function for the system.file to the ggeo package
-
- - ggeo_install_fonts_linux() -
-
Install fonts on Linux
-
- - ggeo_install_fonts_macos() -
-
Install fonts on MacOS
diff --git a/docs/search.json b/docs/search.json index 16eda05..d517335 100644 --- a/docs/search.json +++ b/docs/search.json @@ -1 +1 @@ -[{"path":"https://ggeo.nenuial.org/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 ggeo 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://ggeo.nenuial.org/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Pascal Burkhard. Author, maintainer.","code":""},{"path":"https://ggeo.nenuial.org/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Burkhard P (2024). ggeo: Provide Helpers Themes ggplot. R package version 0.1.0, https://ggeo.nenuial.org.","code":"@Manual{, title = {ggeo: Provide Helpers and Themes for ggplot}, author = {Pascal Burkhard}, year = {2024}, note = {R package version 0.1.0}, url = {https://ggeo.nenuial.org}, }"},{"path":"https://ggeo.nenuial.org/index.html","id":"ggeo-","dir":"","previous_headings":"","what":"Provide Helpers and Themes for ggplot","title":"Provide Helpers and Themes for ggplot","text":"goal ggeo provide support functions create plots maps using {ggplot2}. mainly used {geographer} package.","code":""},{"path":"https://ggeo.nenuial.org/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Provide Helpers and Themes for ggplot","text":"can install latest version ggeo GitHub : r-universe:","code":"# install.packages(\"remotes\") remotes::install_github(\"Nenuial/ggeo\") install.packages(\"ggeo\", repos = c(\"https://nenuial.r-universe.dev\"))"},{"path":"https://ggeo.nenuial.org/index.html","id":"documentation","dir":"","previous_headings":"","what":"Documentation","title":"Provide Helpers and Themes for ggplot","text":"package documentation available https://ggeo.nenuial.org.","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo-package.html","id":null,"dir":"Reference","previous_headings":"","what":"ggeo: Provide Helpers and Themes for ggplot — ggeo-package","title":"ggeo: Provide Helpers and Themes for ggplot — ggeo-package","text":"package provides helper functions ggplot graphs maps.","code":""},{"path":[]},{"path":"https://ggeo.nenuial.org/reference/ggeo-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"ggeo: Provide Helpers and Themes for ggplot — ggeo-package","text":"Maintainer: Pascal Burkhard pascal.burkhard@gmail.com","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_capitalize_title.html","id":null,"dir":"Reference","previous_headings":"","what":"Copitalize plot title — ggeo_capitalize_title","title":"Copitalize plot title — ggeo_capitalize_title","text":"Copitalize plot title","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_capitalize_title.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Copitalize plot title — ggeo_capitalize_title","text":"","code":"ggeo_capitalize_title(plot)"},{"path":"https://ggeo.nenuial.org/reference/ggeo_capitalize_title.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Copitalize plot title — ggeo_capitalize_title","text":"plot ggplot2 object","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_capitalize_title.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Copitalize plot title — ggeo_capitalize_title","text":"ggplot2 object","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_capitalize_title.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Copitalize plot title — ggeo_capitalize_title","text":"","code":"if (FALSE) { # interactive() ggplot(aes(x = speed, y = dist), data = cars) + geom_point() + labs(title = \"Fast cars !\") + ggeo_remove_title() }"},{"path":"https://ggeo.nenuial.org/reference/ggeo_coord.html","id":null,"dir":"Reference","previous_headings":"","what":"Return sf coord for given CRS code — ggeo_coord","title":"Return sf coord for given CRS code — ggeo_coord","text":"function uses geotools::gtl_crs_proj() get CRS configuration applies ggplot2 map.","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_coord.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Return sf coord for given CRS code — ggeo_coord","text":"","code":"ggeo_coord(proj, ...)"},{"path":"https://ggeo.nenuial.org/reference/ggeo_coord.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Return sf coord for given CRS code — ggeo_coord","text":"proj string projection code ... Arguments passed ggplot2::coord_sf xlim,ylim Limits x y axes. limits specified units default CRS. default, means projected coordinates (default_crs = NULL). limit specifications translate exact region shown plot can confusing non-linear rotated coordinate systems used default crs. First, different methods can preferable different conditions. See parameter lims_method details. Second, specifying limits along one direction can affect automatically generated limits along direction. Therefore, best always specify limits x y. Third, specifying limits via position scales xlim()/ylim() strongly discouraged, can result data points dropped plot even though visible final plot region. expand TRUE, default, adds small expansion factor limits ensure data axes overlap. FALSE, limits taken exactly data xlim/ylim. crs coordinate reference system (CRS) data projected plotting. specified, use CRS defined first sf layer plot. default_crs default CRS used non-sf layers (carry CRS information) scale limits. default value NULL means setting crs used. implies non-sf layers scale limits assumed specified projected coordinates. useful alternative setting default_crs = sf::st_crs(4326), means x y positions interpreted longitude latitude, respectively, World Geodetic System 1984 (WGS84). datum CRS provides datum use generating graticules. label_graticule Character vector indicating graticule lines labeled . Meridians run north-south, letters \"N\" \"S\" indicate labeled north south end points, respectively. Parallels run east-west, letters \"E\" \"W\" indicate labeled east west end points, respectively. Thus, label_graticule = \"SW\" label meridians south end parallels west end, whereas label_graticule = \"EW\" label parallels ends meridians . meridians parallels can general intersect side plot panel, choice label_graticule labels guaranteed reside one particular side plot panel. Also, label_graticule can cause labeling artifacts, particular graticule line coincides edge plot panel. circumstances, label_axes generally yield better results used instead. parameter can used alone combination label_axes. label_axes Character vector named list character values specifying graticule lines (meridians parallels) labeled side plot. Meridians indicated \"E\" (East) parallels \"N\" (North). Default \"--EN\", specifies (clockwise top) labels top, none right, meridians bottom, parallels left. Alternatively, setting specified list(bottom = \"E\", left = \"N\"). parameter can used alone combination label_graticule. lims_method Method specifying scale limits converted limits plot region. effect default_crs = NULL. non-linear CRS (e.g., perspective centered around North pole), available methods yield widely differing results, may want try various options. Methods currently implemented include \"cross\" (default), \"box\", \"orthogonal\", \"geometry_bbox\". method \"cross\", limits along one direction (e.g., longitude) applied midpoint direction (e.g., latitude). method avoids excessively large limits rotated coordinate systems means sometimes limits need expanded little extreme data points included final plot region. contrast, method \"box\", box generated limits along directions, limits projected coordinates chosen entire box visible. method can yield plot regions large. Finally, method \"orthogonal\" applies limits separately along axis, method \"geometry_bbox\" ignores limit information except bounding boxes objects geometry aesthetic. ndiscr Number segments use discretising graticule lines; try increasing number graticules look incorrect. default default coordinate system? FALSE (default), replacing coordinate system another one creates message alerting user coordinate system replaced. TRUE, warning suppressed. clip drawing clipped extent plot panel? setting \"\" (default) means yes, setting \"\" means . cases, default \"\" changed, setting clip = \"\" can cause unexpected results. allows drawing data points anywhere plot, including plot margins. limits set via xlim ylim data points fall outside limits, data points may show places axes, legend, plot title, plot margins.","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_coord.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Return sf coord for given CRS code — ggeo_coord","text":"ggplot2 coord object","code":""},{"path":[]},{"path":"https://ggeo.nenuial.org/reference/ggeo_coord.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Return sf coord for given CRS code — ggeo_coord","text":"","code":"if (FALSE) { # interactive() ggeo_coord(\"eqearth\") }"},{"path":"https://ggeo.nenuial.org/reference/ggeo_file.html","id":null,"dir":"Reference","previous_headings":"","what":"A shortcut function for the system.file to the ggeo package — ggeo_file","title":"A shortcut function for the system.file to the ggeo package — ggeo_file","text":"shortcut function system.file ggeo package","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_file.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"A shortcut function for the system.file to the ggeo package — ggeo_file","text":"","code":"ggeo_file(...)"},{"path":"https://ggeo.nenuial.org/reference/ggeo_file.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"A shortcut function for the system.file to the ggeo package — ggeo_file","text":"... Arguments passed base::system.file package character string name single package. error occurs one package name given. lib.loc character vector path names R libraries. See ‘Details’ meaning default value NULL. mustWork logical. TRUE, error given matching files.","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_file.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"A shortcut function for the system.file to the ggeo package — ggeo_file","text":"file path","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_install_fonts_linux.html","id":null,"dir":"Reference","previous_headings":"","what":"Install fonts on Linux — ggeo_install_fonts_linux","title":"Install fonts on Linux — ggeo_install_fonts_linux","text":"Install fonts Linux","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_install_fonts_linux.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install fonts on Linux — ggeo_install_fonts_linux","text":"","code":"ggeo_install_fonts_linux()"},{"path":"https://ggeo.nenuial.org/reference/ggeo_install_fonts_linux.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Install fonts on Linux — ggeo_install_fonts_linux","text":"Move fonts Linux font folders","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_install_fonts_macos.html","id":null,"dir":"Reference","previous_headings":"","what":"Install fonts on MacOS — ggeo_install_fonts_macos","title":"Install fonts on MacOS — ggeo_install_fonts_macos","text":"Install fonts MacOS","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_install_fonts_macos.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install fonts on MacOS — ggeo_install_fonts_macos","text":"","code":"ggeo_install_fonts_macos(system_wide = FALSE)"},{"path":"https://ggeo.nenuial.org/reference/ggeo_install_fonts_macos.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install fonts on MacOS — ggeo_install_fonts_macos","text":"system_wide Install fonts users?","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_install_fonts_macos.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Install fonts on MacOS — ggeo_install_fonts_macos","text":"Move fonts MacOS font folder","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_abs_percent.html","id":null,"dir":"Reference","previous_headings":"","what":"Format labels for relative pyramids — ggeo_label_abs_percent","title":"Format labels for relative pyramids — ggeo_label_abs_percent","text":"Format labels relative pyramids","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_abs_percent.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Format labels for relative pyramids — ggeo_label_abs_percent","text":"","code":"ggeo_label_abs_percent(x)"},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_abs_percent.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Format labels for relative pyramids — ggeo_label_abs_percent","text":"x Number format","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_abs_percent.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Format labels for relative pyramids — ggeo_label_abs_percent","text":"formatted expression","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_pyramid.html","id":null,"dir":"Reference","previous_headings":"","what":"Format labels for pyramids — ggeo_label_pyramid","title":"Format labels for pyramids — ggeo_label_pyramid","text":"Format labels pyramids","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_pyramid.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Format labels for pyramids — ggeo_label_pyramid","text":"","code":"ggeo_label_pyramid(x)"},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_pyramid.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Format labels for pyramids — ggeo_label_pyramid","text":"x Number format","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_pyramid.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Format labels for pyramids — ggeo_label_pyramid","text":"formatted expression","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_sci_10.html","id":null,"dir":"Reference","previous_headings":"","what":"Format labels using scientific notation — ggeo_label_sci_10","title":"Format labels using scientific notation — ggeo_label_sci_10","text":"Format labels using scientific notation","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_sci_10.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Format labels using scientific notation — ggeo_label_sci_10","text":"","code":"ggeo_label_sci_10(x)"},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_sci_10.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Format labels using scientific notation — ggeo_label_sci_10","text":"x Number format","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_sci_10.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Format labels using scientific notation — ggeo_label_sci_10","text":"formatted expression","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_register_fonts.html","id":null,"dir":"Reference","previous_headings":"","what":"Register fonts — ggeo_register_fonts","title":"Register fonts — ggeo_register_fonts","text":"Register fonts","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_register_fonts.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Register fonts — ggeo_register_fonts","text":"","code":"ggeo_register_fonts()"},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_breaks.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove specific breaks — ggeo_remove_breaks","title":"Remove specific breaks — ggeo_remove_breaks","text":"Remove specific breaks","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_breaks.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove specific breaks — ggeo_remove_breaks","text":"","code":"ggeo_remove_breaks(original_func, remove_list = list())"},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_breaks.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove specific breaks — ggeo_remove_breaks","text":"original_func break function remove_list values remove breaks","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_breaks.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove specific breaks — ggeo_remove_breaks","text":"list","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_title.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove plot title — ggeo_remove_title","title":"Remove plot title — ggeo_remove_title","text":"Remove plot title","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_title.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove plot title — ggeo_remove_title","text":"","code":"ggeo_remove_title(plot)"},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_title.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove plot title — ggeo_remove_title","text":"plot ggplot2 object","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_title.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove plot title — ggeo_remove_title","text":"ggplot2 object","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_title.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Remove plot title — ggeo_remove_title","text":"","code":"if (FALSE) { # interactive() ggplot(aes(x = speed, y = dist), data = cars) + geom_point() + labs(title = \"Fast cars !\") + ggeo_remove_title() }"},{"path":"https://ggeo.nenuial.org/reference/ggeo_save.html","id":null,"dir":"Reference","previous_headings":"","what":"Save function — ggeo_save","title":"Save function — ggeo_save","text":"Save function","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_save.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Save function — ggeo_save","text":"","code":"ggeo_save( plot, filename, width = geotools::gtl_options(\"plot_standard_width\"), height = geotools::gtl_options(\"plot_standard_height\"), dpi = 72, units = \"cm\", ... )"},{"path":"https://ggeo.nenuial.org/reference/ggeo_save.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Save function — ggeo_save","text":"plot ggplot2 object save (piped ;) filename Path filename (extension!) width Width. Defaults keynote width (full = geotools::gtl_options(\"plot_full_width\")) height Height. Defaults keynote height (full = geotools::gtl_options(\"plot_full_width\")) dpi DPI. Defaults 72. units Units. Defaults cm. ... Arguments pass ggplot2::ggsave","code":""},{"path":[]},{"path":"https://ggeo.nenuial.org/reference/ggeoformat_pyramid_pop.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Format population labels on pyramids — ggeoformat_pyramid_pop","text":"","code":"ggeoformat_pyramid_pop(x, ...)"},{"path":"https://ggeo.nenuial.org/reference/ggeoformat_pyramid_pop.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Format population labels on pyramids — ggeoformat_pyramid_pop","text":"x label ... compatibility","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeoformat_pyramid_pop.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Format population labels on pyramids — ggeoformat_pyramid_pop","text":"Absolute","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_center.html","id":null,"dir":"Reference","previous_headings":"","what":"Return a color palette with option to center diverging palettes — ggeopal_center","title":"Return a color palette with option to center diverging palettes — ggeopal_center","text":"Return color palette option center diverging palettes","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_center.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Return a color palette with option to center diverging palettes — ggeopal_center","text":"","code":"ggeopal_center(n, center, params)"},{"path":"https://ggeo.nenuial.org/reference/ggeopal_center.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Return a color palette with option to center diverging palettes — ggeopal_center","text":"n Number colors center center (counted left). Use -1 non diverging palettes. params Parameters pass paletteer","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_center.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Return a color palette with option to center diverging palettes — ggeopal_center","text":"vector colors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_chooser.html","id":null,"dir":"Reference","previous_headings":"","what":"Return a paletteer palette depending on — ggeopal_chooser","title":"Return a paletteer palette depending on — ggeopal_chooser","text":"Return paletteer palette depending ","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_chooser.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Return a paletteer palette depending on — ggeopal_chooser","text":"","code":"ggeopal_chooser(n, params)"},{"path":"https://ggeo.nenuial.org/reference/ggeopal_chooser.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Return a paletteer palette depending on — ggeopal_chooser","text":"n Number colors params Parameters pass paletteer Must list : type: type palette, cont, dis dyn palette: paletteer palette dir: palette direction","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_chooser.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Return a paletteer palette depending on — ggeopal_chooser","text":"vector colors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_hex_to_hcl.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate colors from a HEX color using HCL palette — ggeopal_hex_to_hcl","title":"Generate colors from a HEX color using HCL palette — ggeopal_hex_to_hcl","text":"Generate colors HEX color using HCL palette","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_hex_to_hcl.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate colors from a HEX color using HCL palette — ggeopal_hex_to_hcl","text":"","code":"ggeopal_hex_to_hcl(hex, n = 4)"},{"path":"https://ggeo.nenuial.org/reference/ggeopal_hex_to_hcl.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate colors from a HEX color using HCL palette — ggeopal_hex_to_hcl","text":"hex string HEX color n Number colors wanted","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_hex_to_hcl.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate colors from a HEX color using HCL palette — ggeopal_hex_to_hcl","text":"string vector HEX colors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_hex_to_hcl.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate colors from a HEX color using HCL palette — ggeopal_hex_to_hcl","text":"","code":"ggeopal_hex_to_hcl(\"#222b4c\") |> prismatic::color() #> #> #222B4CFF #757889FF #B9BAC3FF #EAEAEDFF ggeopal_hex_to_hcl(\"#222b4c\", 6) |> prismatic::color() #> #> #222B4CFF #5B5F74FF #8D909EFF #B9BAC3FF #DCDDE1FF #F4F5F6FF"},{"path":"https://ggeo.nenuial.org/reference/ggeopal_pal_to_gradient.html","id":null,"dir":"Reference","previous_headings":"","what":"Create gradient for palette colors — ggeopal_pal_to_gradient","title":"Create gradient for palette colors — ggeopal_pal_to_gradient","text":"Create gradient palette colors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_pal_to_gradient.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create gradient for palette colors — ggeopal_pal_to_gradient","text":"","code":"ggeopal_pal_to_gradient(pal)"},{"path":"https://ggeo.nenuial.org/reference/ggeopal_pal_to_gradient.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create gradient for palette colors — ggeopal_pal_to_gradient","text":"pal vector colors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_pal_to_gradient.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create gradient for palette colors — ggeopal_pal_to_gradient","text":"Print color vectors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_to_gradient.html","id":null,"dir":"Reference","previous_headings":"","what":"Create gradient for palette colors — ggeopal_to_gradient","title":"Create gradient for palette colors — ggeopal_to_gradient","text":"Create gradient palette colors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_to_gradient.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create gradient for palette colors — ggeopal_to_gradient","text":"","code":"ggeopal_to_gradient(pal)"},{"path":"https://ggeo.nenuial.org/reference/ggeopal_to_gradient.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create gradient for palette colors — ggeopal_to_gradient","text":"pal vector colors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_to_gradient.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create gradient for palette colors — ggeopal_to_gradient","text":"Print color vectors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_to_gradient.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create gradient for palette colors — ggeopal_to_gradient","text":"","code":"ggeopal_to_gradient(\"#dd4123\") #> #> #FFA199FF #> #> #DD4123FF #> #> #A12400FF #> #> #631200FF ggeopal_to_gradient(\"#ee950b\") #> #> #FFC8A0FF #> #> #EE950BFF #> #> #A46504FF #> #> #5F3901FF ggeopal_to_gradient(\"#0b6b8b\") #> #> #7AB5D6FF #> #> #0B6B8BFF #> #> #044B63FF #> #> #002D3DFF"},{"path":[]},{"path":"https://ggeo.nenuial.org/reference/ggeosave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Save plots to out folder — ggeosave","text":"","code":"ggeosave( filename, ..., format = c(NA, \"keynote\"), width = 63.5, height = 28.57, dpi = 72, units = \"cm\", extension = \"pdf\", device = grDevices::cairo_pdf )"},{"path":"https://ggeo.nenuial.org/reference/ggeosave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Save plots to out folder — ggeosave","text":"filename Name output file ... arguments passed graphics device function, specified device. format Optional: one \"keynote\" width Optional: width output plot height Optional: height output plot dpi Plot resolution. Also accepts string input: \"retina\" (320), \"print\" (300), \"screen\" (72). Applies raster output types. units Optional: units output plot dimensions extension Optional: output file extension device Optional: output device","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeotheme.html","id":null,"dir":"Reference","previous_headings":"","what":"ggeo plot themes — ggeotheme","title":"ggeo plot themes — ggeotheme","text":"function returns ggplot theme elements chosen theme.","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeotheme.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"ggeo plot themes — ggeotheme","text":"","code":"ggeotheme( theme = c(\"ghibli_mononoke\", \"islamic_samarquand\", \"pomological_green\", \"pomological_red\", \"nord_blue\", \"swiss_red\", \"purple\", \"doc\", \"oc_exams\"), main = \"main\", plot = \"plot\", ..., mode = c(\"light\", \"dark\"), base = ggplot2::theme_bw() )"},{"path":"https://ggeo.nenuial.org/reference/ggeotheme.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"ggeo plot themes — ggeotheme","text":"theme Name theme use. One \"ghibli_mononoke\", \"islamic_samarquand\", \"pomological_green\", \"pomological_red\", \"nord_blue\", \"swiss_red\", \"purple\", \"doc\" \"oc_exams\" main One main, main_latex main_exa plot One plot, plot_latex plot_exa ... Arguments passed ggplot2::theme line line elements (element_line()) rect rectangular elements (element_rect()) text text elements (element_text()) title title elements: plot, axes, legends (element_text(); inherits text) aspect.ratio aspect ratio panel axis.title,axis.title.x,axis.title.y,axis.title.x.top,axis.title.x.bottom,axis.title.y.left,axis.title.y.right labels axes (element_text()). Specify axes' labels (axis.title), labels plane (using axis.title.x axis.title.y), individually axis (using axis.title.x.bottom, axis.title.x.top, axis.title.y.left, axis.title.y.right). axis.title.*.* inherits axis.title.* inherits axis.title, turn inherits text axis.text,axis.text.x,axis.text.y,axis.text.x.top,axis.text.x.bottom,axis.text.y.left,axis.text.y.right,axis.text.theta,axis.text.r tick labels along axes (element_text()). Specify axis tick labels (axis.text), tick labels plane (using axis.text.x axis.text.y), individually axis (using axis.text.x.bottom, axis.text.x.top, axis.text.y.left, axis.text.y.right). axis.text.*.* inherits axis.text.* inherits axis.text, turn inherits text axis.ticks,axis.ticks.x,axis.ticks.x.top,axis.ticks.x.bottom,axis.ticks.y,axis.ticks.y.left,axis.ticks.y.right,axis.ticks.theta,axis.ticks.r tick marks along axes (element_line()). Specify tick marks (axis.ticks), ticks plane (using axis.ticks.x axis.ticks.y), individually axis (using axis.ticks.x.bottom, axis.ticks.x.top, axis.ticks.y.left, axis.ticks.y.right). axis.ticks.*.* inherits axis.ticks.* inherits axis.ticks, turn inherits line axis.minor.ticks.x.top,axis.minor.ticks.x.bottom,axis.minor.ticks.y.left,axis.minor.ticks.y.right,axis.minor.ticks.theta,axis.minor.ticks.r minor tick marks along axes (element_line()). axis.minor.ticks.*.* inherit corresponding major ticks axis.ticks.*.*. axis.ticks.length,axis.ticks.length.x,axis.ticks.length.x.top,axis.ticks.length.x.bottom,axis.ticks.length.y,axis.ticks.length.y.left,axis.ticks.length.y.right,axis.ticks.length.theta,axis.ticks.length.r length tick marks (unit) axis.minor.ticks.length,axis.minor.ticks.length.x,axis.minor.ticks.length.x.top,axis.minor.ticks.length.x.bottom,axis.minor.ticks.length.y,axis.minor.ticks.length.y.left,axis.minor.ticks.length.y.right,axis.minor.ticks.length.theta,axis.minor.ticks.length.r length minor tick marks (unit), relative axis.ticks.length provided rel(). axis.line,axis.line.x,axis.line.x.top,axis.line.x.bottom,axis.line.y,axis.line.y.left,axis.line.y.right,axis.line.theta,axis.line.r lines along axes (element_line()). Specify lines along axes (axis.line), lines plane (using axis.line.x axis.line.y), individually axis (using axis.line.x.bottom, axis.line.x.top, axis.line.y.left, axis.line.y.right). axis.line.*.* inherits axis.line.* inherits axis.line, turn inherits line legend.background background legend (element_rect(); inherits rect) legend.margin margin around legend (margin()) legend.spacing,legend.spacing.x,legend.spacing.y spacing legends (unit). legend.spacing.x & legend.spacing.y inherit legend.spacing can specified separately legend.key background underneath legend keys (element_rect(); inherits rect) legend.key.size,legend.key.height,legend.key.width size legend keys (unit); key background height & width inherit legend.key.size can specified separately legend.key.spacing,legend.key.spacing.x,legend.key.spacing.y spacing legend keys given unit. Spacing horizontal (x) vertical (y) direction inherit legend.key.spacing can specified separately. legend.frame frame drawn around bar (element_rect()). legend.ticks tick marks shown along bars axes (element_line()) legend.ticks.length length tick marks legend (unit) legend.axis.line lines along axes legends (element_line()) legend.text legend item labels (element_text(); inherits text) legend.text.position placement legend text relative legend keys bars (\"top\", \"right\", \"bottom\" \"left\"). legend text placement might incompatible legend's direction guides. legend.title title legend (element_text(); inherits title) legend.title.position placement legend title relative main legend (\"top\", \"right\", \"bottom\" \"left\"). legend.position default position legends (\"none\", \"left\", \"right\", \"bottom\", \"top\", \"inside\") legend.position.inside numeric vector length two setting placement legends \"inside\" position. legend.direction layout items legends (\"horizontal\" \"vertical\") legend.byrow whether legend-matrix filled columns (FALSE, default) rows (TRUE). legend.justification anchor point positioning legend inside plot (\"center\" two-element numeric vector) justification according plot area positioned outside plot legend.justification.top,legend.justification.bottom,legend.justification.left,legend.justification.right,legend.justification.inside legend.justification specified per legend.position option. legend.location Relative placement legends outside plot string. Can \"panel\" (default) align legends panels \"plot\" align legends plot whole. legend.box arrangement multiple legends (\"horizontal\" \"vertical\") legend.box.just justification legend within overall bounding box, multiple legends (\"top\", \"bottom\", \"left\", \"right\") legend.box.margin margins around full legend area, specified using margin() legend.box.background background legend area (element_rect(); inherits rect) legend.box.spacing spacing plotting area legend box (unit) panel.background background plotting area, drawn underneath plot (element_rect(); inherits rect) panel.border border around plotting area, drawn top plot covers tick marks grid lines. used fill = NA (element_rect(); inherits rect) panel.spacing,panel.spacing.x,panel.spacing.y spacing facet panels (unit). panel.spacing.x & panel.spacing.y inherit panel.spacing can specified separately. panel.grid,panel.grid.major,panel.grid.minor,panel.grid.major.x,panel.grid.major.y,panel.grid.minor.x,panel.grid.minor.y grid lines (element_line()). Specify major grid lines, minor grid lines separately (using panel.grid.major panel.grid.minor) individually axis (using panel.grid.major.x, panel.grid.minor.x, panel.grid.major.y, panel.grid.minor.y). Y axis grid lines horizontal x axis grid lines vertical. panel.grid.*.* inherits panel.grid.* inherits panel.grid, turn inherits line panel.ontop option place panel (background, gridlines) data layers (logical). Usually used transparent blank panel.background. plot.background background entire plot (element_rect(); inherits rect) plot.title plot title (text appearance) (element_text(); inherits title) left-aligned default plot.title.position,plot.caption.position Alignment plot title/subtitle caption. setting plot.title.position applies title subtitle. value \"panel\" (default) means titles /caption aligned plot panels. value \"plot\" means titles /caption aligned entire plot (minus space margins plot tag). plot.subtitle plot subtitle (text appearance) (element_text(); inherits title) left-aligned default plot.caption caption plot (text appearance) (element_text(); inherits title) right-aligned default plot.tag upper-left label identify plot (text appearance) (element_text(); inherits title) left-aligned default plot.tag.position position tag string (\"topleft\", \"top\", \"topright\", \"left\", \"right\", \"bottomleft\", \"bottom\", \"bottomright\") coordinate. coordinate, can numeric vector length 2 set x,y-coordinate relative whole plot. coordinate option unavailable plot.tag.location = \"margin\". plot.tag.location placement tag string, one \"panel\", \"plot\" \"margin\". Respectively, place tag inside panel space, anywhere plot whole, margin around panel space. plot.margin margin around entire plot (unit sizes top, right, bottom, left margins) strip.background,strip.background.x,strip.background.y background facet labels (element_rect(); inherits rect). Horizontal facet background (strip.background.x) & vertical facet background (strip.background.y) inherit strip.background can specified separately strip.clip strip background edges strip labels clipped extend strip background? Options \"\" clip, \"\" disable clipping \"inherit\" (default) take clipping setting parent viewport. strip.placement placement strip respect axes, either \"inside\" \"outside\". important axes strips side plot. strip.text,strip.text.x,strip.text.y,strip.text.x.top,strip.text.x.bottom,strip.text.y.left,strip.text.y.right facet labels (element_text(); inherits text). Horizontal facet labels (strip.text.x) & vertical facet labels (strip.text.y) inherit strip.text can specified separately. Facet strips dedicated position-dependent theme elements (strip.text.x.top, strip.text.x.bottom, strip.text.y.left, strip.text.y.right) inherit strip.text.x strip.text.y, respectively. consequence, theme stylings need applied position-dependent elements rather parent elements strip.switch.pad.grid space strips axes strips switched (unit) strip.switch.pad.wrap space strips axes strips switched (unit) complete set TRUE complete theme, one returned theme_grey(). Complete themes behave differently added ggplot object. Also, setting complete = TRUE elements set inherit blank elements. validate TRUE run validate_element(), FALSE bypass checks. mode One light dark base ggplot2 theme","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeotheme.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"ggeo plot themes — ggeotheme","text":"object class ggplot2::theme().","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeotheme.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"ggeo plot themes — ggeotheme","text":"","code":"if (FALSE) { # interactive() ggeotheme(\"ghibli_mononoke\") }"},{"path":"https://ggeo.nenuial.org/reference/hc_purple_theme.html","id":null,"dir":"Reference","previous_headings":"","what":"Highchart Theme: Purple Add a purple theme to a highchart — hc_purple_theme","title":"Highchart Theme: Purple Add a purple theme to a highchart — hc_purple_theme","text":"Highchart Theme: Purple Add purple theme highchart","code":""},{"path":"https://ggeo.nenuial.org/reference/hc_purple_theme.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Highchart Theme: Purple Add a purple theme to a highchart — hc_purple_theme","text":"","code":"hc_purple_theme(hc)"},{"path":"https://ggeo.nenuial.org/reference/hc_purple_theme.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Highchart Theme: Purple Add a purple theme to a highchart — hc_purple_theme","text":"hc highchart object","code":""},{"path":"https://ggeo.nenuial.org/reference/hc_purple_theme.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Highchart Theme: Purple Add a purple theme to a highchart — hc_purple_theme","text":"highchart object","code":""},{"path":"https://ggeo.nenuial.org/reference/hc_samarqand_theme.html","id":null,"dir":"Reference","previous_headings":"","what":"Highchart Theme: Samarqand Add a samarqand theme to a highchart — hc_samarqand_theme","title":"Highchart Theme: Samarqand Add a samarqand theme to a highchart — hc_samarqand_theme","text":"Highchart Theme: Samarqand Add samarqand theme highchart","code":""},{"path":"https://ggeo.nenuial.org/reference/hc_samarqand_theme.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Highchart Theme: Samarqand Add a samarqand theme to a highchart — hc_samarqand_theme","text":"","code":"hc_samarqand_theme(hc)"},{"path":"https://ggeo.nenuial.org/reference/hc_samarqand_theme.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Highchart Theme: Samarqand Add a samarqand theme to a highchart — hc_samarqand_theme","text":"hc highchart object","code":""},{"path":"https://ggeo.nenuial.org/reference/hc_samarqand_theme.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Highchart Theme: Samarqand Add a samarqand theme to a highchart — hc_samarqand_theme","text":"highchart object","code":""},{"path":"https://ggeo.nenuial.org/reference/hc_web_theme.html","id":null,"dir":"Reference","previous_headings":"","what":"Highchart Theme: Web Add a web theme to a highchart — hc_web_theme","title":"Highchart Theme: Web Add a web theme to a highchart — hc_web_theme","text":"Highchart Theme: Web Add web theme highchart","code":""},{"path":"https://ggeo.nenuial.org/reference/hc_web_theme.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Highchart Theme: Web Add a web theme to a highchart — hc_web_theme","text":"","code":"hc_web_theme(hc)"},{"path":"https://ggeo.nenuial.org/reference/hc_web_theme.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Highchart Theme: Web Add a web theme to a highchart — hc_web_theme","text":"hc highchart object","code":""},{"path":"https://ggeo.nenuial.org/reference/hc_web_theme.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Highchart Theme: Web Add a web theme to a highchart — hc_web_theme","text":"highchart object","code":""},{"path":"https://ggeo.nenuial.org/reference/palette_chooser.html","id":null,"dir":"Reference","previous_headings":"","what":"Return a paletteer palette depending on — palette_chooser","title":"Return a paletteer palette depending on — palette_chooser","text":"Return paletteer palette depending ","code":""},{"path":"https://ggeo.nenuial.org/reference/palette_chooser.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Return a paletteer palette depending on — palette_chooser","text":"","code":"palette_chooser(n, params)"},{"path":"https://ggeo.nenuial.org/reference/palette_chooser.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Return a paletteer palette depending on — palette_chooser","text":"n Number colors params Parameters pass paletteer Must list : type: type palette, cont, dis dyn palette: paletteer palette dir: palette direction","code":""},{"path":"https://ggeo.nenuial.org/reference/palette_chooser.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Return a paletteer palette depending on — palette_chooser","text":"vector colors","code":""},{"path":"https://ggeo.nenuial.org/reference/reexports.html","id":null,"dir":"Reference","previous_headings":"","what":"Objects exported from other packages — reexports","title":"Objects exported from other packages — reexports","text":"objects imported packages. Follow links see documentation. magrittr %<>%, %>% rlang !!","code":""},{"path":"https://ggeo.nenuial.org/reference/return_palette.html","id":null,"dir":"Reference","previous_headings":"","what":"Return a color palette with option to center diverging palettes — return_palette","title":"Return a color palette with option to center diverging palettes — return_palette","text":"Return color palette option center diverging palettes","code":""},{"path":"https://ggeo.nenuial.org/reference/return_palette.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Return a color palette with option to center diverging palettes — return_palette","text":"","code":"return_palette(n, center, params)"},{"path":"https://ggeo.nenuial.org/reference/return_palette.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Return a color palette with option to center diverging palettes — return_palette","text":"n Number colors center center (counted left). Use -1 non diverging palettes. params Parameters pass paletteer","code":""},{"path":"https://ggeo.nenuial.org/reference/return_palette.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Return a color palette with option to center diverging palettes — return_palette","text":"vector colors","code":""}] +[{"path":"https://ggeo.nenuial.org/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 ggeo 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://ggeo.nenuial.org/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Pascal Burkhard. Author, maintainer.","code":""},{"path":"https://ggeo.nenuial.org/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Burkhard P (2024). ggeo: Provide Helpers Themes ggplot. R package version 0.1.0, https://ggeo.nenuial.org.","code":"@Manual{, title = {ggeo: Provide Helpers and Themes for ggplot}, author = {Pascal Burkhard}, year = {2024}, note = {R package version 0.1.0}, url = {https://ggeo.nenuial.org}, }"},{"path":"https://ggeo.nenuial.org/index.html","id":"ggeo-","dir":"","previous_headings":"","what":"Provide Helpers and Themes for ggplot","title":"Provide Helpers and Themes for ggplot","text":"goal ggeo provide support functions create plots maps using {ggplot2}. mainly used {geographer} package.","code":""},{"path":"https://ggeo.nenuial.org/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Provide Helpers and Themes for ggplot","text":"can install latest version ggeo GitHub : r-universe:","code":"# install.packages(\"remotes\") remotes::install_github(\"Nenuial/ggeo\") install.packages(\"ggeo\", repos = c(\"https://nenuial.r-universe.dev\"))"},{"path":"https://ggeo.nenuial.org/index.html","id":"documentation","dir":"","previous_headings":"","what":"Documentation","title":"Provide Helpers and Themes for ggplot","text":"package documentation available https://ggeo.nenuial.org.","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo-package.html","id":null,"dir":"Reference","previous_headings":"","what":"ggeo: Provide Helpers and Themes for ggplot — ggeo-package","title":"ggeo: Provide Helpers and Themes for ggplot — ggeo-package","text":"package provides helper functions ggplot graphs maps.","code":""},{"path":[]},{"path":"https://ggeo.nenuial.org/reference/ggeo-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"ggeo: Provide Helpers and Themes for ggplot — ggeo-package","text":"Maintainer: Pascal Burkhard pascal.burkhard@gmail.com","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_capitalize_title.html","id":null,"dir":"Reference","previous_headings":"","what":"Copitalize plot title — ggeo_capitalize_title","title":"Copitalize plot title — ggeo_capitalize_title","text":"Copitalize plot title","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_capitalize_title.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Copitalize plot title — ggeo_capitalize_title","text":"","code":"ggeo_capitalize_title(plot)"},{"path":"https://ggeo.nenuial.org/reference/ggeo_capitalize_title.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Copitalize plot title — ggeo_capitalize_title","text":"plot ggplot2 object","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_capitalize_title.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Copitalize plot title — ggeo_capitalize_title","text":"ggplot2 object","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_capitalize_title.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Copitalize plot title — ggeo_capitalize_title","text":"","code":"if (FALSE) { # interactive() ggplot(aes(x = speed, y = dist), data = cars) + geom_point() + labs(title = \"Fast cars !\") + ggeo_remove_title() }"},{"path":"https://ggeo.nenuial.org/reference/ggeo_coord.html","id":null,"dir":"Reference","previous_headings":"","what":"Return sf coord for given CRS code — ggeo_coord","title":"Return sf coord for given CRS code — ggeo_coord","text":"function uses geotools::gtl_crs_proj() get CRS configuration applies ggplot2 map.","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_coord.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Return sf coord for given CRS code — ggeo_coord","text":"","code":"ggeo_coord(code, ...)"},{"path":"https://ggeo.nenuial.org/reference/ggeo_coord.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Return sf coord for given CRS code — ggeo_coord","text":"code string CRS identifier ... Arguments passed ggplot2::coord_sf xlim,ylim Limits x y axes. limits specified units default CRS. default, means projected coordinates (default_crs = NULL). limit specifications translate exact region shown plot can confusing non-linear rotated coordinate systems used default crs. First, different methods can preferable different conditions. See parameter lims_method details. Second, specifying limits along one direction can affect automatically generated limits along direction. Therefore, best always specify limits x y. Third, specifying limits via position scales xlim()/ylim() strongly discouraged, can result data points dropped plot even though visible final plot region. expand TRUE, default, adds small expansion factor limits ensure data axes overlap. FALSE, limits taken exactly data xlim/ylim. crs coordinate reference system (CRS) data projected plotting. specified, use CRS defined first sf layer plot. default_crs default CRS used non-sf layers (carry CRS information) scale limits. default value NULL means setting crs used. implies non-sf layers scale limits assumed specified projected coordinates. useful alternative setting default_crs = sf::st_crs(4326), means x y positions interpreted longitude latitude, respectively, World Geodetic System 1984 (WGS84). datum CRS provides datum use generating graticules. label_graticule Character vector indicating graticule lines labeled . Meridians run north-south, letters \"N\" \"S\" indicate labeled north south end points, respectively. Parallels run east-west, letters \"E\" \"W\" indicate labeled east west end points, respectively. Thus, label_graticule = \"SW\" label meridians south end parallels west end, whereas label_graticule = \"EW\" label parallels ends meridians . meridians parallels can general intersect side plot panel, choice label_graticule labels guaranteed reside one particular side plot panel. Also, label_graticule can cause labeling artifacts, particular graticule line coincides edge plot panel. circumstances, label_axes generally yield better results used instead. parameter can used alone combination label_axes. label_axes Character vector named list character values specifying graticule lines (meridians parallels) labeled side plot. Meridians indicated \"E\" (East) parallels \"N\" (North). Default \"--EN\", specifies (clockwise top) labels top, none right, meridians bottom, parallels left. Alternatively, setting specified list(bottom = \"E\", left = \"N\"). parameter can used alone combination label_graticule. lims_method Method specifying scale limits converted limits plot region. effect default_crs = NULL. non-linear CRS (e.g., perspective centered around North pole), available methods yield widely differing results, may want try various options. Methods currently implemented include \"cross\" (default), \"box\", \"orthogonal\", \"geometry_bbox\". method \"cross\", limits along one direction (e.g., longitude) applied midpoint direction (e.g., latitude). method avoids excessively large limits rotated coordinate systems means sometimes limits need expanded little extreme data points included final plot region. contrast, method \"box\", box generated limits along directions, limits projected coordinates chosen entire box visible. method can yield plot regions large. Finally, method \"orthogonal\" applies limits separately along axis, method \"geometry_bbox\" ignores limit information except bounding boxes objects geometry aesthetic. ndiscr Number segments use discretising graticule lines; try increasing number graticules look incorrect. default default coordinate system? FALSE (default), replacing coordinate system another one creates message alerting user coordinate system replaced. TRUE, warning suppressed. clip drawing clipped extent plot panel? setting \"\" (default) means yes, setting \"\" means . cases, default \"\" changed, setting clip = \"\" can cause unexpected results. allows drawing data points anywhere plot, including plot margins. limits set via xlim ylim data points fall outside limits, data points may show places axes, legend, plot title, plot margins.","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_coord.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Return sf coord for given CRS code — ggeo_coord","text":"ggplot2 coord object","code":""},{"path":[]},{"path":"https://ggeo.nenuial.org/reference/ggeo_coord.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Return sf coord for given CRS code — ggeo_coord","text":"","code":"rnaturalearth::ne_countries() |> ggplot2::ggplot() + ggplot2::geom_sf() + ggeo_coord(\"eqearth\")"},{"path":"https://ggeo.nenuial.org/reference/ggeo_file.html","id":null,"dir":"Reference","previous_headings":"","what":"A shortcut function for the system.file to the ggeo package — ggeo_file","title":"A shortcut function for the system.file to the ggeo package — ggeo_file","text":"shortcut function system.file ggeo package","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_file.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"A shortcut function for the system.file to the ggeo package — ggeo_file","text":"","code":"ggeo_file(...)"},{"path":"https://ggeo.nenuial.org/reference/ggeo_file.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"A shortcut function for the system.file to the ggeo package — ggeo_file","text":"... Arguments passed base::system.file package character string name single package. error occurs one package name given. lib.loc character vector path names R libraries. See ‘Details’ meaning default value NULL. mustWork logical. TRUE, error given matching files.","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_file.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"A shortcut function for the system.file to the ggeo package — ggeo_file","text":"file path","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_install_fonts_linux.html","id":null,"dir":"Reference","previous_headings":"","what":"Install fonts on Linux — ggeo_install_fonts_linux","title":"Install fonts on Linux — ggeo_install_fonts_linux","text":"Install fonts Linux","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_install_fonts_linux.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install fonts on Linux — ggeo_install_fonts_linux","text":"","code":"ggeo_install_fonts_linux()"},{"path":"https://ggeo.nenuial.org/reference/ggeo_install_fonts_linux.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Install fonts on Linux — ggeo_install_fonts_linux","text":"Move fonts Linux font folders","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_install_fonts_macos.html","id":null,"dir":"Reference","previous_headings":"","what":"Install fonts on MacOS — ggeo_install_fonts_macos","title":"Install fonts on MacOS — ggeo_install_fonts_macos","text":"Install fonts MacOS","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_install_fonts_macos.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install fonts on MacOS — ggeo_install_fonts_macos","text":"","code":"ggeo_install_fonts_macos(system_wide = FALSE)"},{"path":"https://ggeo.nenuial.org/reference/ggeo_install_fonts_macos.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install fonts on MacOS — ggeo_install_fonts_macos","text":"system_wide Install fonts users?","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_install_fonts_macos.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Install fonts on MacOS — ggeo_install_fonts_macos","text":"Move fonts MacOS font folder","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_abs_percent.html","id":null,"dir":"Reference","previous_headings":"","what":"Format labels for relative pyramids — ggeo_label_abs_percent","title":"Format labels for relative pyramids — ggeo_label_abs_percent","text":"Format labels relative pyramids","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_abs_percent.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Format labels for relative pyramids — ggeo_label_abs_percent","text":"","code":"ggeo_label_abs_percent(x)"},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_abs_percent.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Format labels for relative pyramids — ggeo_label_abs_percent","text":"x Number format","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_abs_percent.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Format labels for relative pyramids — ggeo_label_abs_percent","text":"formatted expression","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_pyramid.html","id":null,"dir":"Reference","previous_headings":"","what":"Format labels for pyramids — ggeo_label_pyramid","title":"Format labels for pyramids — ggeo_label_pyramid","text":"Format labels pyramids","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_pyramid.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Format labels for pyramids — ggeo_label_pyramid","text":"","code":"ggeo_label_pyramid(x)"},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_pyramid.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Format labels for pyramids — ggeo_label_pyramid","text":"x Number format","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_pyramid.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Format labels for pyramids — ggeo_label_pyramid","text":"formatted expression","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_sci_10.html","id":null,"dir":"Reference","previous_headings":"","what":"Format labels — ggeo_label_sci_10","title":"Format labels — ggeo_label_sci_10","text":"functions extend scales package allow formatting labels.","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_sci_10.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Format labels — ggeo_label_sci_10","text":"","code":"ggeo_label_sci_10(x) ggeo_label_pyramid(x) ggeo_label_abs_percent(x)"},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_sci_10.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Format labels — ggeo_label_sci_10","text":"x Number format","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_sci_10.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Format labels — ggeo_label_sci_10","text":"formatted string scales","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_label_sci_10.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Format labels — ggeo_label_sci_10","text":"ggeo_label_sci_10() used format numbers clean scientific format using multiplier ugly notation using letter e. ggeo_label_pyramid() used population pyramids absolute numbers. formats absolute number using ggeo_label_sci_10(). ggeo_label_abs_percent() also used population pyramids relative numbers (percents). uses scales::percent() absolute numbers.","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_register_fonts.html","id":null,"dir":"Reference","previous_headings":"","what":"Register fonts — ggeo_register_fonts","title":"Register fonts — ggeo_register_fonts","text":"Register fonts","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_register_fonts.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Register fonts — ggeo_register_fonts","text":"","code":"ggeo_register_fonts()"},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_breaks.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove specific breaks — ggeo_remove_breaks","title":"Remove specific breaks — ggeo_remove_breaks","text":"function can used modify breaks ggplot2 scale. specifically designed remove breaks scale.","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_breaks.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove specific breaks — ggeo_remove_breaks","text":"","code":"ggeo_remove_breaks(original_func, remove_list = list())"},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_breaks.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove specific breaks — ggeo_remove_breaks","text":"original_func function create breaks. Use break functions scales remove_list values remove scale.","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_breaks.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove specific breaks — ggeo_remove_breaks","text":"list","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_breaks.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Remove specific breaks — ggeo_remove_breaks","text":"","code":"ggplot2::ggplot(ggplot2::aes(x = speed, y = dist), data = cars) + ggplot2::geom_point() + ggplot2::labs(title = \"Fast cars!\") + ggplot2::scale_y_continuous( breaks = ggeo::ggeo_remove_breaks(scales::breaks_pretty(6), list(0)), )"},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_title.html","id":null,"dir":"Reference","previous_headings":"","what":"Remove plot title — ggeo_remove_title","title":"Remove plot title — ggeo_remove_title","text":"Remove plot title","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_title.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Remove plot title — ggeo_remove_title","text":"","code":"ggeo_remove_title(plot)"},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_title.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Remove plot title — ggeo_remove_title","text":"plot ggplot2 object","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_title.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Remove plot title — ggeo_remove_title","text":"ggplot2 object","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_remove_title.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Remove plot title — ggeo_remove_title","text":"","code":"if (FALSE) { # interactive() ggplot(aes(x = speed, y = dist), data = cars) + geom_point() + labs(title = \"Fast cars !\") + ggeo_remove_title() }"},{"path":"https://ggeo.nenuial.org/reference/ggeo_save.html","id":null,"dir":"Reference","previous_headings":"","what":"Save function — ggeo_save","title":"Save function — ggeo_save","text":"Save function","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_save.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Save function — ggeo_save","text":"","code":"ggeo_save( plot, filename, width = geotools::gtl_options(\"plot_standard_width\"), height = geotools::gtl_options(\"plot_standard_height\"), dpi = 72, units = \"cm\", ... )"},{"path":"https://ggeo.nenuial.org/reference/ggeo_save.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Save function — ggeo_save","text":"plot ggplot2 object save (piped ;) filename Path filename (extension!) width plot width. Defaults keynote width (geotools::gtl_options(\"plot_standard_width\")). full slide width use geotools::gtl_options(\"plot_full_width\"). height plot height. Defaults keynote height (geotools::gtl_options(\"plot_standard_height\")). full slide height use geotools::gtl_options(\"plot_full_height\"). dpi DPI. Default 72. units Units. Default cm. ... Arguments passed ggplot2::ggsave device Device use. Can either device function (e.g. png), one \"eps\", \"ps\", \"tex\" (pictex), \"pdf\", \"jpeg\", \"tiff\", \"png\", \"bmp\", \"svg\" \"wmf\" (windows ). NULL (default), device guessed based filename extension. scale Multiplicative scaling factor. limitsize TRUE (default), ggsave() save images larger 50x50 inches, prevent common error specifying dimensions pixels. bg Background colour. NULL, uses plot.background fill value plot theme. create.dir Whether create new directories non-existing directory specified filename path (TRUE) return error (FALSE, default). FALSE run interactive session, prompt appear asking create new directory necessary.","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeo_save.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Save function — ggeo_save","text":"","code":"if (FALSE) { # interactive() cars |> ggplot2::ggplot(ggplot2::aes(x = speed, y = dist)) + ggplot2::geom_point() -> simple_plot ggeo_save(simple_plot, \"simple_plot.png\") }"},{"path":[]},{"path":"https://ggeo.nenuial.org/reference/ggeoformat_pyramid_pop.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Format population labels on pyramids — ggeoformat_pyramid_pop","text":"","code":"ggeoformat_pyramid_pop(x, ...)"},{"path":"https://ggeo.nenuial.org/reference/ggeoformat_pyramid_pop.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Format population labels on pyramids — ggeoformat_pyramid_pop","text":"x label ... compatibility","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeoformat_pyramid_pop.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Format population labels on pyramids — ggeoformat_pyramid_pop","text":"Absolute","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_center.html","id":null,"dir":"Reference","previous_headings":"","what":"Return a color palette with option to center diverging palettes — ggeopal_center","title":"Return a color palette with option to center diverging palettes — ggeopal_center","text":"Return color palette option center diverging palettes","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_center.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Return a color palette with option to center diverging palettes — ggeopal_center","text":"","code":"ggeopal_center(n, center, params)"},{"path":"https://ggeo.nenuial.org/reference/ggeopal_center.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Return a color palette with option to center diverging palettes — ggeopal_center","text":"n Number colors center center (counted left). Use -1 non diverging palettes. params Parameters pass paletteer","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_center.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Return a color palette with option to center diverging palettes — ggeopal_center","text":"vector colors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_chooser.html","id":null,"dir":"Reference","previous_headings":"","what":"Return a paletteer palette depending on — ggeopal_chooser","title":"Return a paletteer palette depending on — ggeopal_chooser","text":"Return paletteer palette depending ","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_chooser.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Return a paletteer palette depending on — ggeopal_chooser","text":"","code":"ggeopal_chooser(n, params)"},{"path":"https://ggeo.nenuial.org/reference/ggeopal_chooser.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Return a paletteer palette depending on — ggeopal_chooser","text":"n Number colors params Parameters pass paletteer Must list : type: type palette, cont, dis dyn palette: paletteer palette dir: palette direction","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_chooser.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Return a paletteer palette depending on — ggeopal_chooser","text":"vector colors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_hex_to_hcl.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate colors from a HEX color using HCL palette — ggeopal_hex_to_hcl","title":"Generate colors from a HEX color using HCL palette — ggeopal_hex_to_hcl","text":"Generate colors HEX color using HCL palette","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_hex_to_hcl.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate colors from a HEX color using HCL palette — ggeopal_hex_to_hcl","text":"","code":"ggeopal_hex_to_hcl(hex, n = 4)"},{"path":"https://ggeo.nenuial.org/reference/ggeopal_hex_to_hcl.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate colors from a HEX color using HCL palette — ggeopal_hex_to_hcl","text":"hex string HEX color n Number colors wanted","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_hex_to_hcl.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate colors from a HEX color using HCL palette — ggeopal_hex_to_hcl","text":"string vector HEX colors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_hex_to_hcl.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate colors from a HEX color using HCL palette — ggeopal_hex_to_hcl","text":"","code":"ggeopal_hex_to_hcl(\"#222b4c\") |> prismatic::color() #> #> #222B4CFF #757889FF #B9BAC3FF #EAEAEDFF ggeopal_hex_to_hcl(\"#222b4c\", 6) |> prismatic::color() #> #> #222B4CFF #5B5F74FF #8D909EFF #B9BAC3FF #DCDDE1FF #F4F5F6FF"},{"path":"https://ggeo.nenuial.org/reference/ggeopal_pal_to_gradient.html","id":null,"dir":"Reference","previous_headings":"","what":"Create gradient for palette colors — ggeopal_pal_to_gradient","title":"Create gradient for palette colors — ggeopal_pal_to_gradient","text":"Create gradient palette colors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_pal_to_gradient.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create gradient for palette colors — ggeopal_pal_to_gradient","text":"","code":"ggeopal_pal_to_gradient(pal)"},{"path":"https://ggeo.nenuial.org/reference/ggeopal_pal_to_gradient.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create gradient for palette colors — ggeopal_pal_to_gradient","text":"pal vector colors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_pal_to_gradient.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create gradient for palette colors — ggeopal_pal_to_gradient","text":"Print color vectors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_to_gradient.html","id":null,"dir":"Reference","previous_headings":"","what":"Create gradient for palette colors — ggeopal_to_gradient","title":"Create gradient for palette colors — ggeopal_to_gradient","text":"Create gradient palette colors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_to_gradient.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create gradient for palette colors — ggeopal_to_gradient","text":"","code":"ggeopal_to_gradient(pal)"},{"path":"https://ggeo.nenuial.org/reference/ggeopal_to_gradient.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create gradient for palette colors — ggeopal_to_gradient","text":"pal vector colors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_to_gradient.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create gradient for palette colors — ggeopal_to_gradient","text":"Print color vectors","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeopal_to_gradient.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create gradient for palette colors — ggeopal_to_gradient","text":"","code":"ggeopal_to_gradient(\"#dd4123\") #> #> #FFA199FF #> #> #DD4123FF #> #> #A12400FF #> #> #631200FF ggeopal_to_gradient(\"#ee950b\") #> #> #FFC8A0FF #> #> #EE950BFF #> #> #A46504FF #> #> #5F3901FF ggeopal_to_gradient(\"#0b6b8b\") #> #> #7AB5D6FF #> #> #0B6B8BFF #> #> #044B63FF #> #> #002D3DFF"},{"path":[]},{"path":"https://ggeo.nenuial.org/reference/ggeosave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Save plots to out folder — ggeosave","text":"","code":"ggeosave( filename, ..., format = c(NA, \"keynote\"), width = 63.5, height = 28.57, dpi = 72, units = \"cm\", extension = \"pdf\", device = grDevices::cairo_pdf )"},{"path":"https://ggeo.nenuial.org/reference/ggeosave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Save plots to out folder — ggeosave","text":"filename Name output file ... arguments passed graphics device function, specified device. format Optional: one \"keynote\" width Optional: width output plot height Optional: height output plot dpi Plot resolution. Also accepts string input: \"retina\" (320), \"print\" (300), \"screen\" (72). Applies raster output types. units Optional: units output plot dimensions extension Optional: output file extension device Optional: output device","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeotheme.html","id":null,"dir":"Reference","previous_headings":"","what":"ggeo plot themes — ggeotheme","title":"ggeo plot themes — ggeotheme","text":"function returns ggplot theme elements chosen theme.","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeotheme.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"ggeo plot themes — ggeotheme","text":"","code":"ggeotheme( theme = c(\"ghibli_mononoke\", \"islamic_samarquand\", \"pomological_green\", \"pomological_red\", \"nord_blue\", \"swiss_red\", \"purple\", \"doc\", \"oc_exams\"), main = \"main\", plot = \"plot\", ..., mode = c(\"light\", \"dark\"), base = ggplot2::theme_bw() )"},{"path":"https://ggeo.nenuial.org/reference/ggeotheme.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"ggeo plot themes — ggeotheme","text":"theme Name theme use. One \"ghibli_mononoke\", \"islamic_samarquand\", \"pomological_green\", \"pomological_red\", \"nord_blue\", \"swiss_red\", \"purple\", \"doc\" \"oc_exams\" main One main, main_latex main_exa plot One plot, plot_latex plot_exa ... Arguments passed ggplot2::theme line line elements (element_line()) rect rectangular elements (element_rect()) text text elements (element_text()) title title elements: plot, axes, legends (element_text(); inherits text) aspect.ratio aspect ratio panel axis.title,axis.title.x,axis.title.y,axis.title.x.top,axis.title.x.bottom,axis.title.y.left,axis.title.y.right labels axes (element_text()). Specify axes' labels (axis.title), labels plane (using axis.title.x axis.title.y), individually axis (using axis.title.x.bottom, axis.title.x.top, axis.title.y.left, axis.title.y.right). axis.title.*.* inherits axis.title.* inherits axis.title, turn inherits text axis.text,axis.text.x,axis.text.y,axis.text.x.top,axis.text.x.bottom,axis.text.y.left,axis.text.y.right,axis.text.theta,axis.text.r tick labels along axes (element_text()). Specify axis tick labels (axis.text), tick labels plane (using axis.text.x axis.text.y), individually axis (using axis.text.x.bottom, axis.text.x.top, axis.text.y.left, axis.text.y.right). axis.text.*.* inherits axis.text.* inherits axis.text, turn inherits text axis.ticks,axis.ticks.x,axis.ticks.x.top,axis.ticks.x.bottom,axis.ticks.y,axis.ticks.y.left,axis.ticks.y.right,axis.ticks.theta,axis.ticks.r tick marks along axes (element_line()). Specify tick marks (axis.ticks), ticks plane (using axis.ticks.x axis.ticks.y), individually axis (using axis.ticks.x.bottom, axis.ticks.x.top, axis.ticks.y.left, axis.ticks.y.right). axis.ticks.*.* inherits axis.ticks.* inherits axis.ticks, turn inherits line axis.minor.ticks.x.top,axis.minor.ticks.x.bottom,axis.minor.ticks.y.left,axis.minor.ticks.y.right,axis.minor.ticks.theta,axis.minor.ticks.r minor tick marks along axes (element_line()). axis.minor.ticks.*.* inherit corresponding major ticks axis.ticks.*.*. axis.ticks.length,axis.ticks.length.x,axis.ticks.length.x.top,axis.ticks.length.x.bottom,axis.ticks.length.y,axis.ticks.length.y.left,axis.ticks.length.y.right,axis.ticks.length.theta,axis.ticks.length.r length tick marks (unit) axis.minor.ticks.length,axis.minor.ticks.length.x,axis.minor.ticks.length.x.top,axis.minor.ticks.length.x.bottom,axis.minor.ticks.length.y,axis.minor.ticks.length.y.left,axis.minor.ticks.length.y.right,axis.minor.ticks.length.theta,axis.minor.ticks.length.r length minor tick marks (unit), relative axis.ticks.length provided rel(). axis.line,axis.line.x,axis.line.x.top,axis.line.x.bottom,axis.line.y,axis.line.y.left,axis.line.y.right,axis.line.theta,axis.line.r lines along axes (element_line()). Specify lines along axes (axis.line), lines plane (using axis.line.x axis.line.y), individually axis (using axis.line.x.bottom, axis.line.x.top, axis.line.y.left, axis.line.y.right). axis.line.*.* inherits axis.line.* inherits axis.line, turn inherits line legend.background background legend (element_rect(); inherits rect) legend.margin margin around legend (margin()) legend.spacing,legend.spacing.x,legend.spacing.y spacing legends (unit). legend.spacing.x & legend.spacing.y inherit legend.spacing can specified separately legend.key background underneath legend keys (element_rect(); inherits rect) legend.key.size,legend.key.height,legend.key.width size legend keys (unit); key background height & width inherit legend.key.size can specified separately legend.key.spacing,legend.key.spacing.x,legend.key.spacing.y spacing legend keys given unit. Spacing horizontal (x) vertical (y) direction inherit legend.key.spacing can specified separately. legend.frame frame drawn around bar (element_rect()). legend.ticks tick marks shown along bars axes (element_line()) legend.ticks.length length tick marks legend (unit) legend.axis.line lines along axes legends (element_line()) legend.text legend item labels (element_text(); inherits text) legend.text.position placement legend text relative legend keys bars (\"top\", \"right\", \"bottom\" \"left\"). legend text placement might incompatible legend's direction guides. legend.title title legend (element_text(); inherits title) legend.title.position placement legend title relative main legend (\"top\", \"right\", \"bottom\" \"left\"). legend.position default position legends (\"none\", \"left\", \"right\", \"bottom\", \"top\", \"inside\") legend.position.inside numeric vector length two setting placement legends \"inside\" position. legend.direction layout items legends (\"horizontal\" \"vertical\") legend.byrow whether legend-matrix filled columns (FALSE, default) rows (TRUE). legend.justification anchor point positioning legend inside plot (\"center\" two-element numeric vector) justification according plot area positioned outside plot legend.justification.top,legend.justification.bottom,legend.justification.left,legend.justification.right,legend.justification.inside legend.justification specified per legend.position option. legend.location Relative placement legends outside plot string. Can \"panel\" (default) align legends panels \"plot\" align legends plot whole. legend.box arrangement multiple legends (\"horizontal\" \"vertical\") legend.box.just justification legend within overall bounding box, multiple legends (\"top\", \"bottom\", \"left\", \"right\") legend.box.margin margins around full legend area, specified using margin() legend.box.background background legend area (element_rect(); inherits rect) legend.box.spacing spacing plotting area legend box (unit) panel.background background plotting area, drawn underneath plot (element_rect(); inherits rect) panel.border border around plotting area, drawn top plot covers tick marks grid lines. used fill = NA (element_rect(); inherits rect) panel.spacing,panel.spacing.x,panel.spacing.y spacing facet panels (unit). panel.spacing.x & panel.spacing.y inherit panel.spacing can specified separately. panel.grid,panel.grid.major,panel.grid.minor,panel.grid.major.x,panel.grid.major.y,panel.grid.minor.x,panel.grid.minor.y grid lines (element_line()). Specify major grid lines, minor grid lines separately (using panel.grid.major panel.grid.minor) individually axis (using panel.grid.major.x, panel.grid.minor.x, panel.grid.major.y, panel.grid.minor.y). Y axis grid lines horizontal x axis grid lines vertical. panel.grid.*.* inherits panel.grid.* inherits panel.grid, turn inherits line panel.ontop option place panel (background, gridlines) data layers (logical). Usually used transparent blank panel.background. plot.background background entire plot (element_rect(); inherits rect) plot.title plot title (text appearance) (element_text(); inherits title) left-aligned default plot.title.position,plot.caption.position Alignment plot title/subtitle caption. setting plot.title.position applies title subtitle. value \"panel\" (default) means titles /caption aligned plot panels. value \"plot\" means titles /caption aligned entire plot (minus space margins plot tag). plot.subtitle plot subtitle (text appearance) (element_text(); inherits title) left-aligned default plot.caption caption plot (text appearance) (element_text(); inherits title) right-aligned default plot.tag upper-left label identify plot (text appearance) (element_text(); inherits title) left-aligned default plot.tag.position position tag string (\"topleft\", \"top\", \"topright\", \"left\", \"right\", \"bottomleft\", \"bottom\", \"bottomright\") coordinate. coordinate, can numeric vector length 2 set x,y-coordinate relative whole plot. coordinate option unavailable plot.tag.location = \"margin\". plot.tag.location placement tag string, one \"panel\", \"plot\" \"margin\". Respectively, place tag inside panel space, anywhere plot whole, margin around panel space. plot.margin margin around entire plot (unit sizes top, right, bottom, left margins) strip.background,strip.background.x,strip.background.y background facet labels (element_rect(); inherits rect). Horizontal facet background (strip.background.x) & vertical facet background (strip.background.y) inherit strip.background can specified separately strip.clip strip background edges strip labels clipped extend strip background? Options \"\" clip, \"\" disable clipping \"inherit\" (default) take clipping setting parent viewport. strip.placement placement strip respect axes, either \"inside\" \"outside\". important axes strips side plot. strip.text,strip.text.x,strip.text.y,strip.text.x.top,strip.text.x.bottom,strip.text.y.left,strip.text.y.right facet labels (element_text(); inherits text). Horizontal facet labels (strip.text.x) & vertical facet labels (strip.text.y) inherit strip.text can specified separately. Facet strips dedicated position-dependent theme elements (strip.text.x.top, strip.text.x.bottom, strip.text.y.left, strip.text.y.right) inherit strip.text.x strip.text.y, respectively. consequence, theme stylings need applied position-dependent elements rather parent elements strip.switch.pad.grid space strips axes strips switched (unit) strip.switch.pad.wrap space strips axes strips switched (unit) complete set TRUE complete theme, one returned theme_grey(). Complete themes behave differently added ggplot object. Also, setting complete = TRUE elements set inherit blank elements. validate TRUE run validate_element(), FALSE bypass checks. mode One light dark base ggplot2 theme","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeotheme.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"ggeo plot themes — ggeotheme","text":"object class ggplot2::theme().","code":""},{"path":"https://ggeo.nenuial.org/reference/ggeotheme.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"ggeo plot themes — ggeotheme","text":"","code":"if (FALSE) { # interactive() ggeotheme(\"ghibli_mononoke\") }"},{"path":"https://ggeo.nenuial.org/reference/hc_purple_theme.html","id":null,"dir":"Reference","previous_headings":"","what":"Highcharts themes — hc_purple_theme","title":"Highcharts themes — hc_purple_theme","text":"functions can used modify theme highcharts plot.","code":""},{"path":"https://ggeo.nenuial.org/reference/hc_purple_theme.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Highcharts themes — hc_purple_theme","text":"","code":"hc_purple_theme(hc) hc_samarqand_theme(hc) hc_web_theme(hc)"},{"path":"https://ggeo.nenuial.org/reference/hc_purple_theme.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Highcharts themes — hc_purple_theme","text":"hc highcharts object","code":""},{"path":"https://ggeo.nenuial.org/reference/hc_purple_theme.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Highcharts themes — hc_purple_theme","text":"highcharts object","code":""},{"path":"https://ggeo.nenuial.org/reference/hc_purple_theme.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Highcharts themes — hc_purple_theme","text":"","code":"highcharter::hchart( cars, \"point\", highcharter::hcaes(x = speed, y = dist) ) |> hc_purple_theme() #> Registered S3 method overwritten by 'quantmod': #> method from #> as.zoo.data.frame zoo {\"x\":{\"hc_opts\":{\"chart\":{\"reflow\":true},\"title\":{\"text\":null},\"yAxis\":{\"title\":{\"text\":\"dist\"},\"type\":\"linear\"},\"credits\":{\"enabled\":false},\"exporting\":{\"enabled\":false},\"boost\":{\"enabled\":false},\"plotOptions\":{\"series\":{\"label\":{\"enabled\":false},\"turboThreshold\":0,\"showInLegend\":false},\"treemap\":{\"layoutAlgorithm\":\"squarified\"},\"scatter\":{\"marker\":{\"symbol\":\"circle\"}}},\"series\":[{\"group\":\"group\",\"data\":[{\"speed\":4,\"dist\":2,\"x\":4,\"y\":2},{\"speed\":4,\"dist\":10,\"x\":4,\"y\":10},{\"speed\":7,\"dist\":4,\"x\":7,\"y\":4},{\"speed\":7,\"dist\":22,\"x\":7,\"y\":22},{\"speed\":8,\"dist\":16,\"x\":8,\"y\":16},{\"speed\":9,\"dist\":10,\"x\":9,\"y\":10},{\"speed\":10,\"dist\":18,\"x\":10,\"y\":18},{\"speed\":10,\"dist\":26,\"x\":10,\"y\":26},{\"speed\":10,\"dist\":34,\"x\":10,\"y\":34},{\"speed\":11,\"dist\":17,\"x\":11,\"y\":17},{\"speed\":11,\"dist\":28,\"x\":11,\"y\":28},{\"speed\":12,\"dist\":14,\"x\":12,\"y\":14},{\"speed\":12,\"dist\":20,\"x\":12,\"y\":20},{\"speed\":12,\"dist\":24,\"x\":12,\"y\":24},{\"speed\":12,\"dist\":28,\"x\":12,\"y\":28},{\"speed\":13,\"dist\":26,\"x\":13,\"y\":26},{\"speed\":13,\"dist\":34,\"x\":13,\"y\":34},{\"speed\":13,\"dist\":34,\"x\":13,\"y\":34},{\"speed\":13,\"dist\":46,\"x\":13,\"y\":46},{\"speed\":14,\"dist\":26,\"x\":14,\"y\":26},{\"speed\":14,\"dist\":36,\"x\":14,\"y\":36},{\"speed\":14,\"dist\":60,\"x\":14,\"y\":60},{\"speed\":14,\"dist\":80,\"x\":14,\"y\":80},{\"speed\":15,\"dist\":20,\"x\":15,\"y\":20},{\"speed\":15,\"dist\":26,\"x\":15,\"y\":26},{\"speed\":15,\"dist\":54,\"x\":15,\"y\":54},{\"speed\":16,\"dist\":32,\"x\":16,\"y\":32},{\"speed\":16,\"dist\":40,\"x\":16,\"y\":40},{\"speed\":17,\"dist\":32,\"x\":17,\"y\":32},{\"speed\":17,\"dist\":40,\"x\":17,\"y\":40},{\"speed\":17,\"dist\":50,\"x\":17,\"y\":50},{\"speed\":18,\"dist\":42,\"x\":18,\"y\":42},{\"speed\":18,\"dist\":56,\"x\":18,\"y\":56},{\"speed\":18,\"dist\":76,\"x\":18,\"y\":76},{\"speed\":18,\"dist\":84,\"x\":18,\"y\":84},{\"speed\":19,\"dist\":36,\"x\":19,\"y\":36},{\"speed\":19,\"dist\":46,\"x\":19,\"y\":46},{\"speed\":19,\"dist\":68,\"x\":19,\"y\":68},{\"speed\":20,\"dist\":32,\"x\":20,\"y\":32},{\"speed\":20,\"dist\":48,\"x\":20,\"y\":48},{\"speed\":20,\"dist\":52,\"x\":20,\"y\":52},{\"speed\":20,\"dist\":56,\"x\":20,\"y\":56},{\"speed\":20,\"dist\":64,\"x\":20,\"y\":64},{\"speed\":22,\"dist\":66,\"x\":22,\"y\":66},{\"speed\":23,\"dist\":54,\"x\":23,\"y\":54},{\"speed\":24,\"dist\":70,\"x\":24,\"y\":70},{\"speed\":24,\"dist\":92,\"x\":24,\"y\":92},{\"speed\":24,\"dist\":93,\"x\":24,\"y\":93},{\"speed\":24,\"dist\":120,\"x\":24,\"y\":120},{\"speed\":25,\"dist\":85,\"x\":25,\"y\":85}],\"type\":\"scatter\"}],\"xAxis\":{\"type\":\"linear\",\"title\":{\"text\":\"speed\"},\"categories\":null}},\"theme\":{\"colors\":[\"#E6A0C4\",\"#C6CDF7\",\"#D8A499\",\"#7294D4\"],\"chart\":{\"backgroundColor\":\"transparent\"},\"title\":{\"style\":{\"color\":\"#a84890\",\"fontFamily\":\"Fira Sans\",\"fontSize\":\"52px\",\"fontWeight\":\"400\"}},\"subtitle\":{\"style\":{\"color\":\"#a84890\",\"fontFamily\":\"Fira Sans\",\"fontSize\":\"38px\",\"fontWeight\":\"300\"}},\"legend\":{\"itemStyle\":{\"fontFamily\":\"Fira Sans\",\"fontWeight\":\"100\",\"fontSize\":\"24px\",\"color\":\"#e0d9fb\"},\"itemHoverStyle\":{\"color\":\"#e0d9fb\"}},\"tooltip\":{\"headerFormat\":\"{point.key}<\\/span>
\",\"style\":{\"fontFamily\":\"Fira Sans\",\"fontWeight\":\"200\",\"fontSize\":\"28px\"}},\"caption\":{\"style\":{\"fontFamily\":\"Fira Sans\",\"fontWeight\":\"100\",\"fontSize\":\"24px\",\"color\":\"#e0d9fb\"}},\"xAxis\":{\"labels\":{\"style\":{\"fontFamily\":\"Fira Sans\",\"fontWeight\":\"100\",\"fontSize\":\"24px\",\"color\":\"#e0d9fb\"}},\"title\":{\"style\":{\"fontFamily\":\"Fira Sans\",\"fontWeight\":\"300\",\"fontSize\":\"24px\",\"color\":\"#ced2fa\"}}},\"yAxis\":{\"labels\":{\"style\":{\"fontFamily\":\"Fira Sans\",\"fontWeight\":\"100\",\"fontSize\":\"24px\",\"color\":\"#e0d9fb\"}},\"title\":{\"style\":{\"fontFamily\":\"Fira Sans\",\"fontWeight\":\"300\",\"fontSize\":\"24px\",\"color\":\"#ced2fa\"}}}},\"conf_opts\":{\"global\":{\"Date\":null,\"VMLRadialGradientURL\":\"http =//code.highcharts.com/list(version)/gfx/vml-radial-gradient.png\",\"canvasToolsURL\":\"http =//code.highcharts.com/list(version)/modules/canvas-tools.js\",\"getTimezoneOffset\":null,\"timezoneOffset\":0,\"useUTC\":true},\"lang\":{\"contextButtonTitle\":\"Chart context menu\",\"decimalPoint\":\".\",\"downloadCSV\":\"Download CSV\",\"downloadJPEG\":\"Download JPEG image\",\"downloadPDF\":\"Download PDF document\",\"downloadPNG\":\"Download PNG image\",\"downloadSVG\":\"Download SVG vector image\",\"downloadXLS\":\"Download XLS\",\"drillUpText\":\"◁ Back to {series.name}\",\"exitFullscreen\":\"Exit from full screen\",\"exportData\":{\"annotationHeader\":\"Annotations\",\"categoryDatetimeHeader\":\"DateTime\",\"categoryHeader\":\"Category\"},\"hideData\":\"Hide data table\",\"invalidDate\":null,\"loading\":\"Loading...\",\"months\":[\"January\",\"February\",\"March\",\"April\",\"May\",\"June\",\"July\",\"August\",\"September\",\"October\",\"November\",\"December\"],\"noData\":\"No data to display\",\"numericSymbolMagnitude\":1000,\"numericSymbols\":[\"k\",\"M\",\"G\",\"T\",\"P\",\"E\"],\"printChart\":\"Print chart\",\"resetZoom\":\"Reset zoom\",\"resetZoomTitle\":\"Reset zoom level 1:1\",\"shortMonths\":[\"Jan\",\"Feb\",\"Mar\",\"Apr\",\"May\",\"Jun\",\"Jul\",\"Aug\",\"Sep\",\"Oct\",\"Nov\",\"Dec\"],\"shortWeekdays\":[\"Sat\",\"Sun\",\"Mon\",\"Tue\",\"Wed\",\"Thu\",\"Fri\"],\"thousandsSep\":\" \",\"viewData\":\"View data table\",\"viewFullscreen\":\"View in full screen\",\"weekdays\":[\"Sunday\",\"Monday\",\"Tuesday\",\"Wednesday\",\"Thursday\",\"Friday\",\"Saturday\"]}},\"type\":\"chart\",\"fonts\":\"Fira+Sans\",\"debug\":false},\"evals\":[],\"jsHooks\":[]} highcharter::hchart( cars, \"point\", highcharter::hcaes(x = speed, y = dist) ) |> hc_samarqand_theme() {\"x\":{\"hc_opts\":{\"chart\":{\"reflow\":true},\"title\":{\"text\":null},\"yAxis\":{\"title\":{\"text\":\"dist\"},\"type\":\"linear\"},\"credits\":{\"enabled\":false},\"exporting\":{\"enabled\":false},\"boost\":{\"enabled\":false},\"plotOptions\":{\"series\":{\"label\":{\"enabled\":false},\"turboThreshold\":0,\"showInLegend\":false},\"treemap\":{\"layoutAlgorithm\":\"squarified\"},\"scatter\":{\"marker\":{\"symbol\":\"circle\"}}},\"series\":[{\"group\":\"group\",\"data\":[{\"speed\":4,\"dist\":2,\"x\":4,\"y\":2},{\"speed\":4,\"dist\":10,\"x\":4,\"y\":10},{\"speed\":7,\"dist\":4,\"x\":7,\"y\":4},{\"speed\":7,\"dist\":22,\"x\":7,\"y\":22},{\"speed\":8,\"dist\":16,\"x\":8,\"y\":16},{\"speed\":9,\"dist\":10,\"x\":9,\"y\":10},{\"speed\":10,\"dist\":18,\"x\":10,\"y\":18},{\"speed\":10,\"dist\":26,\"x\":10,\"y\":26},{\"speed\":10,\"dist\":34,\"x\":10,\"y\":34},{\"speed\":11,\"dist\":17,\"x\":11,\"y\":17},{\"speed\":11,\"dist\":28,\"x\":11,\"y\":28},{\"speed\":12,\"dist\":14,\"x\":12,\"y\":14},{\"speed\":12,\"dist\":20,\"x\":12,\"y\":20},{\"speed\":12,\"dist\":24,\"x\":12,\"y\":24},{\"speed\":12,\"dist\":28,\"x\":12,\"y\":28},{\"speed\":13,\"dist\":26,\"x\":13,\"y\":26},{\"speed\":13,\"dist\":34,\"x\":13,\"y\":34},{\"speed\":13,\"dist\":34,\"x\":13,\"y\":34},{\"speed\":13,\"dist\":46,\"x\":13,\"y\":46},{\"speed\":14,\"dist\":26,\"x\":14,\"y\":26},{\"speed\":14,\"dist\":36,\"x\":14,\"y\":36},{\"speed\":14,\"dist\":60,\"x\":14,\"y\":60},{\"speed\":14,\"dist\":80,\"x\":14,\"y\":80},{\"speed\":15,\"dist\":20,\"x\":15,\"y\":20},{\"speed\":15,\"dist\":26,\"x\":15,\"y\":26},{\"speed\":15,\"dist\":54,\"x\":15,\"y\":54},{\"speed\":16,\"dist\":32,\"x\":16,\"y\":32},{\"speed\":16,\"dist\":40,\"x\":16,\"y\":40},{\"speed\":17,\"dist\":32,\"x\":17,\"y\":32},{\"speed\":17,\"dist\":40,\"x\":17,\"y\":40},{\"speed\":17,\"dist\":50,\"x\":17,\"y\":50},{\"speed\":18,\"dist\":42,\"x\":18,\"y\":42},{\"speed\":18,\"dist\":56,\"x\":18,\"y\":56},{\"speed\":18,\"dist\":76,\"x\":18,\"y\":76},{\"speed\":18,\"dist\":84,\"x\":18,\"y\":84},{\"speed\":19,\"dist\":36,\"x\":19,\"y\":36},{\"speed\":19,\"dist\":46,\"x\":19,\"y\":46},{\"speed\":19,\"dist\":68,\"x\":19,\"y\":68},{\"speed\":20,\"dist\":32,\"x\":20,\"y\":32},{\"speed\":20,\"dist\":48,\"x\":20,\"y\":48},{\"speed\":20,\"dist\":52,\"x\":20,\"y\":52},{\"speed\":20,\"dist\":56,\"x\":20,\"y\":56},{\"speed\":20,\"dist\":64,\"x\":20,\"y\":64},{\"speed\":22,\"dist\":66,\"x\":22,\"y\":66},{\"speed\":23,\"dist\":54,\"x\":23,\"y\":54},{\"speed\":24,\"dist\":70,\"x\":24,\"y\":70},{\"speed\":24,\"dist\":92,\"x\":24,\"y\":92},{\"speed\":24,\"dist\":93,\"x\":24,\"y\":93},{\"speed\":24,\"dist\":120,\"x\":24,\"y\":120},{\"speed\":25,\"dist\":85,\"x\":25,\"y\":85}],\"type\":\"scatter\"}],\"xAxis\":{\"type\":\"linear\",\"title\":{\"text\":\"speed\"},\"categories\":null}},\"theme\":{\"colors\":[\"#E6A0C4\",\"#C6CDF7\",\"#D8A499\",\"#7294D4\"],\"chart\":{\"backgroundColor\":\"transparent\"},\"title\":{\"style\":{\"color\":\"#6098c0\",\"fontFamily\":\"Fira Sans\",\"fontSize\":\"52px\",\"fontWeight\":\"400\"}},\"subtitle\":{\"style\":{\"color\":\"#6098c0\",\"fontFamily\":\"Fira Sans\",\"fontSize\":\"38px\",\"fontWeight\":\"300\"}},\"legend\":{\"itemStyle\":{\"fontFamily\":\"Fira Sans\",\"fontWeight\":\"100\",\"fontSize\":\"24px\",\"color\":\"#cec0a5\"},\"itemHoverStyle\":{\"color\":\"#cec0a5\"}},\"tooltip\":{\"headerFormat\":\"{point.key}<\\/span>
\",\"style\":{\"fontFamily\":\"Fira Sans\",\"fontWeight\":\"200\",\"fontSize\":\"28px\"}},\"caption\":{\"style\":{\"fontFamily\":\"Fira Sans\",\"fontWeight\":\"100\",\"fontSize\":\"24px\",\"color\":\"#cec0a5\"}},\"xAxis\":{\"labels\":{\"style\":{\"fontFamily\":\"Fira Sans\",\"fontWeight\":\"100\",\"fontSize\":\"24px\",\"color\":\"#cec0a5\"}},\"title\":{\"style\":{\"fontFamily\":\"Fira Sans\",\"fontWeight\":\"300\",\"fontSize\":\"24px\",\"color\":\"#c0d9eb\"}}},\"yAxis\":{\"labels\":{\"style\":{\"fontFamily\":\"Fira Sans\",\"fontWeight\":\"100\",\"fontSize\":\"24px\",\"color\":\"#cec0a5\"}},\"title\":{\"style\":{\"fontFamily\":\"Fira Sans\",\"fontWeight\":\"300\",\"fontSize\":\"24px\",\"color\":\"#c0d9eb\"}}}},\"conf_opts\":{\"global\":{\"Date\":null,\"VMLRadialGradientURL\":\"http =//code.highcharts.com/list(version)/gfx/vml-radial-gradient.png\",\"canvasToolsURL\":\"http =//code.highcharts.com/list(version)/modules/canvas-tools.js\",\"getTimezoneOffset\":null,\"timezoneOffset\":0,\"useUTC\":true},\"lang\":{\"contextButtonTitle\":\"Chart context menu\",\"decimalPoint\":\".\",\"downloadCSV\":\"Download CSV\",\"downloadJPEG\":\"Download JPEG image\",\"downloadPDF\":\"Download PDF document\",\"downloadPNG\":\"Download PNG image\",\"downloadSVG\":\"Download SVG vector image\",\"downloadXLS\":\"Download XLS\",\"drillUpText\":\"◁ Back to {series.name}\",\"exitFullscreen\":\"Exit from full screen\",\"exportData\":{\"annotationHeader\":\"Annotations\",\"categoryDatetimeHeader\":\"DateTime\",\"categoryHeader\":\"Category\"},\"hideData\":\"Hide data table\",\"invalidDate\":null,\"loading\":\"Loading...\",\"months\":[\"January\",\"February\",\"March\",\"April\",\"May\",\"June\",\"July\",\"August\",\"September\",\"October\",\"November\",\"December\"],\"noData\":\"No data to display\",\"numericSymbolMagnitude\":1000,\"numericSymbols\":[\"k\",\"M\",\"G\",\"T\",\"P\",\"E\"],\"printChart\":\"Print chart\",\"resetZoom\":\"Reset zoom\",\"resetZoomTitle\":\"Reset zoom level 1:1\",\"shortMonths\":[\"Jan\",\"Feb\",\"Mar\",\"Apr\",\"May\",\"Jun\",\"Jul\",\"Aug\",\"Sep\",\"Oct\",\"Nov\",\"Dec\"],\"shortWeekdays\":[\"Sat\",\"Sun\",\"Mon\",\"Tue\",\"Wed\",\"Thu\",\"Fri\"],\"thousandsSep\":\" \",\"viewData\":\"View data table\",\"viewFullscreen\":\"View in full screen\",\"weekdays\":[\"Sunday\",\"Monday\",\"Tuesday\",\"Wednesday\",\"Thursday\",\"Friday\",\"Saturday\"]}},\"type\":\"chart\",\"fonts\":\"Fira+Sans\",\"debug\":false},\"evals\":[],\"jsHooks\":[]} highcharter::hchart( cars, \"point\", highcharter::hcaes(x = speed, y = dist) ) |> hc_web_theme() {\"x\":{\"hc_opts\":{\"chart\":{\"reflow\":true},\"title\":{\"text\":null},\"yAxis\":{\"title\":{\"text\":\"dist\"},\"type\":\"linear\"},\"credits\":{\"enabled\":false},\"exporting\":{\"enabled\":false},\"boost\":{\"enabled\":false},\"plotOptions\":{\"series\":{\"label\":{\"enabled\":false},\"turboThreshold\":0,\"showInLegend\":false},\"treemap\":{\"layoutAlgorithm\":\"squarified\"},\"scatter\":{\"marker\":{\"symbol\":\"circle\"}}},\"series\":[{\"group\":\"group\",\"data\":[{\"speed\":4,\"dist\":2,\"x\":4,\"y\":2},{\"speed\":4,\"dist\":10,\"x\":4,\"y\":10},{\"speed\":7,\"dist\":4,\"x\":7,\"y\":4},{\"speed\":7,\"dist\":22,\"x\":7,\"y\":22},{\"speed\":8,\"dist\":16,\"x\":8,\"y\":16},{\"speed\":9,\"dist\":10,\"x\":9,\"y\":10},{\"speed\":10,\"dist\":18,\"x\":10,\"y\":18},{\"speed\":10,\"dist\":26,\"x\":10,\"y\":26},{\"speed\":10,\"dist\":34,\"x\":10,\"y\":34},{\"speed\":11,\"dist\":17,\"x\":11,\"y\":17},{\"speed\":11,\"dist\":28,\"x\":11,\"y\":28},{\"speed\":12,\"dist\":14,\"x\":12,\"y\":14},{\"speed\":12,\"dist\":20,\"x\":12,\"y\":20},{\"speed\":12,\"dist\":24,\"x\":12,\"y\":24},{\"speed\":12,\"dist\":28,\"x\":12,\"y\":28},{\"speed\":13,\"dist\":26,\"x\":13,\"y\":26},{\"speed\":13,\"dist\":34,\"x\":13,\"y\":34},{\"speed\":13,\"dist\":34,\"x\":13,\"y\":34},{\"speed\":13,\"dist\":46,\"x\":13,\"y\":46},{\"speed\":14,\"dist\":26,\"x\":14,\"y\":26},{\"speed\":14,\"dist\":36,\"x\":14,\"y\":36},{\"speed\":14,\"dist\":60,\"x\":14,\"y\":60},{\"speed\":14,\"dist\":80,\"x\":14,\"y\":80},{\"speed\":15,\"dist\":20,\"x\":15,\"y\":20},{\"speed\":15,\"dist\":26,\"x\":15,\"y\":26},{\"speed\":15,\"dist\":54,\"x\":15,\"y\":54},{\"speed\":16,\"dist\":32,\"x\":16,\"y\":32},{\"speed\":16,\"dist\":40,\"x\":16,\"y\":40},{\"speed\":17,\"dist\":32,\"x\":17,\"y\":32},{\"speed\":17,\"dist\":40,\"x\":17,\"y\":40},{\"speed\":17,\"dist\":50,\"x\":17,\"y\":50},{\"speed\":18,\"dist\":42,\"x\":18,\"y\":42},{\"speed\":18,\"dist\":56,\"x\":18,\"y\":56},{\"speed\":18,\"dist\":76,\"x\":18,\"y\":76},{\"speed\":18,\"dist\":84,\"x\":18,\"y\":84},{\"speed\":19,\"dist\":36,\"x\":19,\"y\":36},{\"speed\":19,\"dist\":46,\"x\":19,\"y\":46},{\"speed\":19,\"dist\":68,\"x\":19,\"y\":68},{\"speed\":20,\"dist\":32,\"x\":20,\"y\":32},{\"speed\":20,\"dist\":48,\"x\":20,\"y\":48},{\"speed\":20,\"dist\":52,\"x\":20,\"y\":52},{\"speed\":20,\"dist\":56,\"x\":20,\"y\":56},{\"speed\":20,\"dist\":64,\"x\":20,\"y\":64},{\"speed\":22,\"dist\":66,\"x\":22,\"y\":66},{\"speed\":23,\"dist\":54,\"x\":23,\"y\":54},{\"speed\":24,\"dist\":70,\"x\":24,\"y\":70},{\"speed\":24,\"dist\":92,\"x\":24,\"y\":92},{\"speed\":24,\"dist\":93,\"x\":24,\"y\":93},{\"speed\":24,\"dist\":120,\"x\":24,\"y\":120},{\"speed\":25,\"dist\":85,\"x\":25,\"y\":85}],\"type\":\"scatter\"}],\"xAxis\":{\"type\":\"linear\",\"title\":{\"text\":\"speed\"},\"categories\":null}},\"theme\":{\"colors\":[\"#E6A0C4\",\"#C6CDF7\",\"#D8A499\",\"#7294D4\"],\"chart\":{\"backgroundColor\":\"transparent\"},\"title\":{\"style\":{\"color\":\"#73819B\",\"fontFamily\":\"Fira Sans\"}},\"subtitle\":{\"style\":{\"color\":\"#73819B\",\"fontFamily\":\"Fira Sans\"}},\"legend\":{\"itemStyle\":{\"fontFamily\":\"Fira Sans\",\"color\":\"#4c566a\"},\"itemHoverStyle\":{\"color\":\"#4c566a\"}},\"tooltip\":{\"style\":{\"fontFamily\":\"Fira Sans\"}},\"caption\":{\"style\":{\"fontFamily\":\"Fira Sans\",\"color\":\"#4c566a\"}},\"xAxis\":{\"labels\":{\"style\":{\"fontFamily\":\"Fira Sans\",\"color\":\"#4c566a\"}},\"title\":{\"style\":{\"fontFamily\":\"Fira Sans\",\"color\":\"#73819B\"}}},\"yAxis\":{\"labels\":{\"style\":{\"fontFamily\":\"Fira Sans\",\"color\":\"#4c566a\"}},\"title\":{\"style\":{\"fontFamily\":\"Fira Sans\",\"color\":\"#73819B\"}}}},\"conf_opts\":{\"global\":{\"Date\":null,\"VMLRadialGradientURL\":\"http =//code.highcharts.com/list(version)/gfx/vml-radial-gradient.png\",\"canvasToolsURL\":\"http =//code.highcharts.com/list(version)/modules/canvas-tools.js\",\"getTimezoneOffset\":null,\"timezoneOffset\":0,\"useUTC\":true},\"lang\":{\"contextButtonTitle\":\"Chart context menu\",\"decimalPoint\":\".\",\"downloadCSV\":\"Download CSV\",\"downloadJPEG\":\"Download JPEG image\",\"downloadPDF\":\"Download PDF document\",\"downloadPNG\":\"Download PNG image\",\"downloadSVG\":\"Download SVG vector image\",\"downloadXLS\":\"Download XLS\",\"drillUpText\":\"◁ Back to {series.name}\",\"exitFullscreen\":\"Exit from full screen\",\"exportData\":{\"annotationHeader\":\"Annotations\",\"categoryDatetimeHeader\":\"DateTime\",\"categoryHeader\":\"Category\"},\"hideData\":\"Hide data table\",\"invalidDate\":null,\"loading\":\"Loading...\",\"months\":[\"January\",\"February\",\"March\",\"April\",\"May\",\"June\",\"July\",\"August\",\"September\",\"October\",\"November\",\"December\"],\"noData\":\"No data to display\",\"numericSymbolMagnitude\":1000,\"numericSymbols\":[\"k\",\"M\",\"G\",\"T\",\"P\",\"E\"],\"printChart\":\"Print chart\",\"resetZoom\":\"Reset zoom\",\"resetZoomTitle\":\"Reset zoom level 1:1\",\"shortMonths\":[\"Jan\",\"Feb\",\"Mar\",\"Apr\",\"May\",\"Jun\",\"Jul\",\"Aug\",\"Sep\",\"Oct\",\"Nov\",\"Dec\"],\"shortWeekdays\":[\"Sat\",\"Sun\",\"Mon\",\"Tue\",\"Wed\",\"Thu\",\"Fri\"],\"thousandsSep\":\" \",\"viewData\":\"View data table\",\"viewFullscreen\":\"View in full screen\",\"weekdays\":[\"Sunday\",\"Monday\",\"Tuesday\",\"Wednesday\",\"Thursday\",\"Friday\",\"Saturday\"]}},\"type\":\"chart\",\"fonts\":\"Fira+Sans\",\"debug\":false},\"evals\":[],\"jsHooks\":[]}"},{"path":"https://ggeo.nenuial.org/reference/hc_samarqand_theme.html","id":null,"dir":"Reference","previous_headings":"","what":"Highchart Theme: Samarqand Add a samarqand theme to a highchart — hc_samarqand_theme","title":"Highchart Theme: Samarqand Add a samarqand theme to a highchart — hc_samarqand_theme","text":"Highchart Theme: Samarqand Add samarqand theme highchart","code":""},{"path":"https://ggeo.nenuial.org/reference/hc_samarqand_theme.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Highchart Theme: Samarqand Add a samarqand theme to a highchart — hc_samarqand_theme","text":"","code":"hc_samarqand_theme(hc)"},{"path":"https://ggeo.nenuial.org/reference/hc_samarqand_theme.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Highchart Theme: Samarqand Add a samarqand theme to a highchart — hc_samarqand_theme","text":"hc highchart object","code":""},{"path":"https://ggeo.nenuial.org/reference/hc_samarqand_theme.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Highchart Theme: Samarqand Add a samarqand theme to a highchart — hc_samarqand_theme","text":"highchart object","code":""},{"path":"https://ggeo.nenuial.org/reference/hc_web_theme.html","id":null,"dir":"Reference","previous_headings":"","what":"Highchart Theme: Web Add a web theme to a highchart — hc_web_theme","title":"Highchart Theme: Web Add a web theme to a highchart — hc_web_theme","text":"Highchart Theme: Web Add web theme highchart","code":""},{"path":"https://ggeo.nenuial.org/reference/hc_web_theme.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Highchart Theme: Web Add a web theme to a highchart — hc_web_theme","text":"","code":"hc_web_theme(hc)"},{"path":"https://ggeo.nenuial.org/reference/hc_web_theme.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Highchart Theme: Web Add a web theme to a highchart — hc_web_theme","text":"hc highchart object","code":""},{"path":"https://ggeo.nenuial.org/reference/hc_web_theme.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Highchart Theme: Web Add a web theme to a highchart — hc_web_theme","text":"highchart object","code":""},{"path":"https://ggeo.nenuial.org/reference/palette_chooser.html","id":null,"dir":"Reference","previous_headings":"","what":"Return a paletteer palette depending on — palette_chooser","title":"Return a paletteer palette depending on — palette_chooser","text":"Return paletteer palette depending ","code":""},{"path":"https://ggeo.nenuial.org/reference/palette_chooser.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Return a paletteer palette depending on — palette_chooser","text":"","code":"palette_chooser(n, params)"},{"path":"https://ggeo.nenuial.org/reference/palette_chooser.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Return a paletteer palette depending on — palette_chooser","text":"n Number colors params Parameters pass paletteer Must list : type: type palette, cont, dis dyn palette: paletteer palette dir: palette direction","code":""},{"path":"https://ggeo.nenuial.org/reference/palette_chooser.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Return a paletteer palette depending on — palette_chooser","text":"vector colors","code":""},{"path":"https://ggeo.nenuial.org/reference/reexports.html","id":null,"dir":"Reference","previous_headings":"","what":"Objects exported from other packages — reexports","title":"Objects exported from other packages — reexports","text":"objects imported packages. Follow links see documentation. magrittr %<>%, %>% rlang !!","code":""},{"path":"https://ggeo.nenuial.org/reference/return_palette.html","id":null,"dir":"Reference","previous_headings":"","what":"Return a color palette with option to center diverging palettes — return_palette","title":"Return a color palette with option to center diverging palettes — return_palette","text":"Return color palette option center diverging palettes","code":""},{"path":"https://ggeo.nenuial.org/reference/return_palette.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Return a color palette with option to center diverging palettes — return_palette","text":"","code":"return_palette(n, center, params)"},{"path":"https://ggeo.nenuial.org/reference/return_palette.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Return a color palette with option to center diverging palettes — return_palette","text":"n Number colors center center (counted left). Use -1 non diverging palettes. params Parameters pass paletteer","code":""},{"path":"https://ggeo.nenuial.org/reference/return_palette.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Return a color palette with option to center diverging palettes — return_palette","text":"vector colors","code":""}] diff --git a/man/ggeo-package.Rd b/man/ggeo-package.Rd index 9341343..8bdeacb 100644 --- a/man/ggeo-package.Rd +++ b/man/ggeo-package.Rd @@ -6,6 +6,8 @@ \alias{ggeo-package} \title{ggeo: Provide Helpers and Themes for ggplot} \description{ +\if{html}{\figure{logo.png}{options: style='float: right' alt='logo' width='120'}} + This package provides helper functions for ggplot graphs and maps. } \seealso{ diff --git a/man/ggeo_capitalize_title.Rd b/man/ggeo_capitalize_title.Rd index efcd8ab..db4fdaa 100644 --- a/man/ggeo_capitalize_title.Rd +++ b/man/ggeo_capitalize_title.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/plot_utils.R +% Please edit documentation in R/ggplot_utils.R \name{ggeo_capitalize_title} \alias{ggeo_capitalize_title} \title{Copitalize plot title} diff --git a/man/ggeo_coord.Rd b/man/ggeo_coord.Rd index 35cc87d..4a618ef 100644 --- a/man/ggeo_coord.Rd +++ b/man/ggeo_coord.Rd @@ -4,10 +4,10 @@ \alias{ggeo_coord} \title{Return sf coord for given CRS code} \usage{ -ggeo_coord(proj, ...) +ggeo_coord(code, ...) } \arguments{ -\item{proj}{A string for the projection code} +\item{code}{A string with the CRS identifier} \item{...}{ Arguments passed on to \code{\link[ggplot2:ggsf]{ggplot2::coord_sf}} @@ -102,9 +102,11 @@ get the CRS configuration and applies it to a ggplot2 map. } \examples{ -\dontshow{if (interactive()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} -ggeo_coord("eqearth") -\dontshow{\}) # examplesIf} +rnaturalearth::ne_countries() |> + ggplot2::ggplot() + + ggplot2::geom_sf() + + ggeo_coord("eqearth") + } \seealso{ \code{\link[geotools:gtl_crs_proj]{geotools::gtl_crs_proj()}} diff --git a/man/ggeo_file.Rd b/man/ggeo_file.Rd index 84b0344..e663deb 100644 --- a/man/ggeo_file.Rd +++ b/man/ggeo_file.Rd @@ -24,3 +24,4 @@ A file path \description{ A shortcut function for the system.file to the ggeo package } +\keyword{internal} diff --git a/man/ggeo_install_fonts_linux.Rd b/man/ggeo_install_fonts_linux.Rd index d27cf2c..c5525b6 100644 --- a/man/ggeo_install_fonts_linux.Rd +++ b/man/ggeo_install_fonts_linux.Rd @@ -12,3 +12,4 @@ Move fonts to Linux font folders \description{ Install fonts on Linux } +\keyword{internal} diff --git a/man/ggeo_install_fonts_macos.Rd b/man/ggeo_install_fonts_macos.Rd index 11c1e58..81a060a 100644 --- a/man/ggeo_install_fonts_macos.Rd +++ b/man/ggeo_install_fonts_macos.Rd @@ -15,3 +15,4 @@ Move fonts to MacOS font folder \description{ Install fonts on MacOS } +\keyword{internal} diff --git a/man/ggeo_label_abs_percent.Rd b/man/ggeo_label_abs_percent.Rd deleted file mode 100644 index 1cfd261..0000000 --- a/man/ggeo_label_abs_percent.Rd +++ /dev/null @@ -1,17 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/scales.R -\name{ggeo_label_abs_percent} -\alias{ggeo_label_abs_percent} -\title{Format labels for relative pyramids} -\usage{ -ggeo_label_abs_percent(x) -} -\arguments{ -\item{x}{Number to format} -} -\value{ -A formatted expression -} -\description{ -Format labels for relative pyramids -} diff --git a/man/ggeo_label_pyramid.Rd b/man/ggeo_label_pyramid.Rd deleted file mode 100644 index 1fb4f46..0000000 --- a/man/ggeo_label_pyramid.Rd +++ /dev/null @@ -1,17 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/scales.R -\name{ggeo_label_pyramid} -\alias{ggeo_label_pyramid} -\title{Format labels for pyramids} -\usage{ -ggeo_label_pyramid(x) -} -\arguments{ -\item{x}{Number to format} -} -\value{ -A formatted expression -} -\description{ -Format labels for pyramids -} diff --git a/man/ggeo_label_sci_10.Rd b/man/ggeo_label_sci_10.Rd index 410be82..5b80963 100644 --- a/man/ggeo_label_sci_10.Rd +++ b/man/ggeo_label_sci_10.Rd @@ -1,17 +1,37 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/scales.R +% Please edit documentation in R/ggplot_scales.R \name{ggeo_label_sci_10} \alias{ggeo_label_sci_10} -\title{Format labels using scientific notation} +\alias{ggeo_label_pyramid} +\alias{ggeo_label_abs_percent} +\title{Format labels} \usage{ ggeo_label_sci_10(x) + +ggeo_label_pyramid(x) + +ggeo_label_abs_percent(x) } \arguments{ \item{x}{Number to format} } \value{ -A formatted expression +A formatted string for the scales } \description{ -Format labels using scientific notation +These functions extend the {\href{https://scales.r-lib.org}{scales}} +package and allow formatting labels. +} +\details{ +\code{\link[=ggeo_label_sci_10]{ggeo_label_sci_10()}} is used to format numbers with a clean +scientific format using a multiplier and not the \emph{ugly} notation +using the letter \emph{e}. + +\code{\link[=ggeo_label_pyramid]{ggeo_label_pyramid()}} is used for population pyramids with +absolute numbers. It formats the absolute number using +\code{\link[=ggeo_label_sci_10]{ggeo_label_sci_10()}}. + +\code{\link[=ggeo_label_abs_percent]{ggeo_label_abs_percent()}} is also used for population pyramids +but with relative numbers (percents). It uses \code{\link[scales:percent_format]{scales::percent()}} +and absolute numbers. } diff --git a/man/ggeo_remove_breaks.Rd b/man/ggeo_remove_breaks.Rd index abcc4fb..e281db5 100644 --- a/man/ggeo_remove_breaks.Rd +++ b/man/ggeo_remove_breaks.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/scales.R +% Please edit documentation in R/ggplot_scales.R \name{ggeo_remove_breaks} \alias{ggeo_remove_breaks} \title{Remove specific breaks} @@ -7,13 +7,25 @@ ggeo_remove_breaks(original_func, remove_list = list()) } \arguments{ -\item{original_func}{The break function} +\item{original_func}{The function to create the breaks. +Use the break functions from the {\href{https://scales.r-lib.org}{scales}}} -\item{remove_list}{The values to remove from the breaks} +\item{remove_list}{The values to remove from the scale.} } \value{ A list } \description{ -Remove specific breaks +This function can be used to modify the breaks of a ggplot2 +scale. It is specifically designed to remove the some breaks +in the scale. +} +\examples{ +ggplot2::ggplot(ggplot2::aes(x = speed, y = dist), data = cars) + + ggplot2::geom_point() + + ggplot2::labs(title = "Fast cars!") + + ggplot2::scale_y_continuous( + breaks = ggeo::ggeo_remove_breaks(scales::breaks_pretty(6), list(0)), + ) + } diff --git a/man/ggeo_remove_title.Rd b/man/ggeo_remove_title.Rd index d7a7e5b..94b10ad 100644 --- a/man/ggeo_remove_title.Rd +++ b/man/ggeo_remove_title.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/plot_utils.R +% Please edit documentation in R/ggplot_utils.R \name{ggeo_remove_title} \alias{ggeo_remove_title} \title{Remove plot title} diff --git a/man/ggeo_save.Rd b/man/ggeo_save.Rd index 961e545..5de4843 100644 --- a/man/ggeo_save.Rd +++ b/man/ggeo_save.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/plot_save.R +% Please edit documentation in R/ggplot_utils.R \name{ggeo_save} \alias{ggeo_save} \title{Save function} @@ -15,20 +15,50 @@ ggeo_save( ) } \arguments{ -\item{plot}{The ggplot2 object to save (should by piped in ;)} +\item{plot}{The ggplot2 object to save (should be piped in ;)} \item{filename}{Path for filename (with extension!)} -\item{width}{Width. Defaults to keynote width (full = geotools::gtl_options("plot_full_width"))} +\item{width}{The plot width. +Defaults to keynote width (\code{geotools::gtl_options("plot_standard_width")}). +For full slide width use \code{geotools::gtl_options("plot_full_width")}.} -\item{height}{Height. Defaults to keynote height (full = geotools::gtl_options("plot_full_width"))} +\item{height}{The plot height. +Defaults to keynote height (\code{geotools::gtl_options("plot_standard_height")}). +For full slide height use \code{geotools::gtl_options("plot_full_height")}.} -\item{dpi}{DPI. Defaults to 72.} +\item{dpi}{The DPI. Default is 72.} -\item{units}{Units. Defaults to cm.} +\item{units}{Units. Default is cm.} -\item{...}{Arguments to pass to ggplot2::ggsave} +\item{...}{ + Arguments passed on to \code{\link[ggplot2:ggsave]{ggplot2::ggsave}} + \describe{ + \item{\code{device}}{Device to use. Can either be a device function +(e.g. \link{png}), or one of "eps", "ps", "tex" (pictex), +"pdf", "jpeg", "tiff", "png", "bmp", "svg" or "wmf" (windows only). If +\code{NULL} (default), the device is guessed based on the \code{filename} extension.} + \item{\code{scale}}{Multiplicative scaling factor.} + \item{\code{limitsize}}{When \code{TRUE} (the default), \code{ggsave()} will not +save images larger than 50x50 inches, to prevent the common error of +specifying dimensions in pixels.} + \item{\code{bg}}{Background colour. If \code{NULL}, uses the \code{plot.background} fill value +from the plot theme.} + \item{\code{create.dir}}{Whether to create new directories if a non-existing +directory is specified in the \code{filename} or \code{path} (\code{TRUE}) or return an +error (\code{FALSE}, default). If \code{FALSE} and run in an interactive session, +a prompt will appear asking to create a new directory when necessary.} + }} } \description{ Save function } +\examples{ +\dontshow{if (interactive()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +cars |> + ggplot2::ggplot(ggplot2::aes(x = speed, y = dist)) + + ggplot2::geom_point() -> simple_plot + +ggeo_save(simple_plot, "simple_plot.png") +\dontshow{\}) # examplesIf} +} diff --git a/man/ggeoformat_pyramid_pop.Rd b/man/ggeoformat_pyramid_pop.Rd index 1ac4573..a148eaf 100644 --- a/man/ggeoformat_pyramid_pop.Rd +++ b/man/ggeoformat_pyramid_pop.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/scales.R +% Please edit documentation in R/ggplot_scales.R \name{ggeoformat_pyramid_pop} \alias{ggeoformat_pyramid_pop} \title{Format population labels on pyramids} diff --git a/man/ggeosave.Rd b/man/ggeosave.Rd index 6458377..d24557b 100644 --- a/man/ggeosave.Rd +++ b/man/ggeosave.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/plot_save.R +% Please edit documentation in R/ggplot_utils.R \name{ggeosave} \alias{ggeosave} \title{Save plots to out folder} diff --git a/man/hc_purple_theme.Rd b/man/hc_purple_theme.Rd index 865c9f6..a1c078b 100644 --- a/man/hc_purple_theme.Rd +++ b/man/hc_purple_theme.Rd @@ -2,18 +2,43 @@ % Please edit documentation in R/highcharter_themes.R \name{hc_purple_theme} \alias{hc_purple_theme} -\title{Highchart Theme: Purple -Add a purple theme to a highchart} +\alias{hc_samarqand_theme} +\alias{hc_web_theme} +\title{Highcharts themes} \usage{ hc_purple_theme(hc) + +hc_samarqand_theme(hc) + +hc_web_theme(hc) } \arguments{ -\item{hc}{A highchart object} +\item{hc}{A highcharts object} } \value{ -A highchart object +A highcharts object } \description{ -Highchart Theme: Purple -Add a purple theme to a highchart +These functions can be used to modify the theme of +a highcharts plot. +} +\examples{ +highcharter::hchart( + cars, "point", + highcharter::hcaes(x = speed, y = dist) +) |> + hc_purple_theme() + +highcharter::hchart( + cars, "point", + highcharter::hcaes(x = speed, y = dist) +) |> + hc_samarqand_theme() + +highcharter::hchart( + cars, "point", + highcharter::hcaes(x = speed, y = dist) +) |> + hc_web_theme() + } diff --git a/man/hc_samarqand_theme.Rd b/man/hc_samarqand_theme.Rd deleted file mode 100644 index dcc510a..0000000 --- a/man/hc_samarqand_theme.Rd +++ /dev/null @@ -1,19 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/highcharter_themes.R -\name{hc_samarqand_theme} -\alias{hc_samarqand_theme} -\title{Highchart Theme: Samarqand -Add a samarqand theme to a highchart} -\usage{ -hc_samarqand_theme(hc) -} -\arguments{ -\item{hc}{A highchart object} -} -\value{ -A highchart object -} -\description{ -Highchart Theme: Samarqand -Add a samarqand theme to a highchart -} diff --git a/man/hc_web_theme.Rd b/man/hc_web_theme.Rd deleted file mode 100644 index 4b75b82..0000000 --- a/man/hc_web_theme.Rd +++ /dev/null @@ -1,19 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/highcharter_themes.R -\name{hc_web_theme} -\alias{hc_web_theme} -\title{Highchart Theme: Web -Add a web theme to a highchart} -\usage{ -hc_web_theme(hc) -} -\arguments{ -\item{hc}{A highchart object} -} -\value{ -A highchart object -} -\description{ -Highchart Theme: Web -Add a web theme to a highchart -}