commit
5e08875bea
55 changed files with 1376 additions and 1387 deletions
|
|
@ -1,7 +1,7 @@
|
||||||
Package: visualizeR
|
Package: visualizeR
|
||||||
Type: Package
|
Type: Package
|
||||||
Title: What a color! What a viz!
|
Title: What a color! What a viz!
|
||||||
Version: 0.1.7.9000
|
Version: 0.2.9000
|
||||||
Authors@R: c(
|
Authors@R: c(
|
||||||
person(
|
person(
|
||||||
'Noblet', 'Guillaume',
|
'Noblet', 'Guillaume',
|
||||||
|
|
@ -24,6 +24,6 @@ Imports:
|
||||||
grDevices,
|
grDevices,
|
||||||
glue,
|
glue,
|
||||||
scales,
|
scales,
|
||||||
ggblanket
|
ggblanket (>= 1.5.0)
|
||||||
Suggests: knitr, sf
|
Suggests: knitr, sf
|
||||||
VignetteBuilder: knitr
|
VignetteBuilder: knitr
|
||||||
|
|
|
||||||
8
NEWS.md
8
NEWS.md
|
|
@ -1,3 +1,11 @@
|
||||||
|
# visualizeR 0.2.9000
|
||||||
|
|
||||||
|
* Breaking changes: almost all functions got refinements, and there are new functions, typically `hbar()` becomes `bar_reach()` and `point_reach()` is added.
|
||||||
|
* Following `theme_reach()` is now used by all plotting functions.
|
||||||
|
* Add README.md.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
# visualizeR 0.1.7.9000
|
# visualizeR 0.1.7.9000
|
||||||
|
|
||||||
* Fixed some color palettes.
|
* Fixed some color palettes.
|
||||||
|
|
|
||||||
74
R/bar.R
Normal file
74
R/bar.R
Normal file
|
|
@ -0,0 +1,74 @@
|
||||||
|
#' @title Simple bar chart
|
||||||
|
#'
|
||||||
|
#' @param df A data frame.
|
||||||
|
#' @param x A numeric column.
|
||||||
|
#' @param y A character column or coercible as a character column.
|
||||||
|
#' @param group Some grouping categorical column, e.g. administrative areas or population groups.
|
||||||
|
#' @param palette Palette name from 'pal_reach()'.
|
||||||
|
#' @param percent TRUE or FALSE. Should the x-labels be displayed as percentages? Default to TRUE.
|
||||||
|
#' @param reverse Boolean indicating whether the palette should be reversed.
|
||||||
|
#' @param family The font family for all plot's texts. Default to "Leelawadee".
|
||||||
|
#' @param alpha Transparency.
|
||||||
|
#' @param width Width.
|
||||||
|
#' @param x_title The x scale title. Default to NULL.
|
||||||
|
#' @param y_title The y scale title. Default to NULL.
|
||||||
|
#' @param group_title The group legend title. Default to NULL.
|
||||||
|
#' @param position Should the chart be stacked? Default to "dodge". Can take "dodge" and "stack".
|
||||||
|
#' @param title Plot title. Default to NULL.
|
||||||
|
#' @param subtitle Plot subtitle. Default to NULL.
|
||||||
|
#' @param caption Caption title string. Default to NULL.
|
||||||
|
#' @param text_size The size of all text other than the title, subtitle and caption. Defaults to 10.
|
||||||
|
#' @param title_size The size of the title text. Defaults to 14.
|
||||||
|
#' @param legend_position Position of the legend; Default to "right". Can take "right", "left", "top", "bottom" or "none".
|
||||||
|
#' @param legend_rev Reverse the color in the guide? Default to TRUE.
|
||||||
|
#' @param void Boolean to remove all elements from the plot. Default to FALSE.
|
||||||
|
#' @param ... Other arguments to be passed to "ggblanket::gg_col"
|
||||||
|
#'
|
||||||
|
#' @description `ggblanket` as internals for deciding whether the bar chart is horizontally readable.
|
||||||
|
#'
|
||||||
|
#' @return A bar chart
|
||||||
|
#'
|
||||||
|
#' @export
|
||||||
|
bar_reach <- function(df, x, y, group = NULL, percent = TRUE, palette = "main", reverse = FALSE, family = "Leelawadee", alpha = 1, width = 0.5, x_title = NULL, y_title = NULL, group_title = NULL, position = "dodge", title = NULL, subtitle = NULL, caption = NULL, text_size = 10, title_size = 14, legend_position = "right", legend_rev = TRUE, void = FALSE, ...){
|
||||||
|
|
||||||
|
pal <- pal_reach(palette)
|
||||||
|
|
||||||
|
if(is.null(pal)) rlang::warn(
|
||||||
|
c(paste0("There is no palette '", palette, "' for initiative 'reach'. Fallback to ggblanket's default color palette."),
|
||||||
|
"i" = paste0("Use `pal_reach(show_palettes = T)` to see the list of availabale palettes.")
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
if (percent) x_labels <- scales::percent else x_labels <- NULL
|
||||||
|
|
||||||
|
pl <- df |>
|
||||||
|
ggblanket::gg_col(x = {{ x }},
|
||||||
|
y = {{ y }},
|
||||||
|
col = {{ group }},
|
||||||
|
x_title = x_title,
|
||||||
|
x_labels = x_labels,
|
||||||
|
y_title = y_title,
|
||||||
|
col_title = group_title,
|
||||||
|
alpha = alpha,
|
||||||
|
width = width,
|
||||||
|
position = position,
|
||||||
|
title = title,
|
||||||
|
subtitle = subtitle,
|
||||||
|
caption = caption,
|
||||||
|
col_legend_place = legend_position,
|
||||||
|
theme = theme_reach(
|
||||||
|
palette = palette,
|
||||||
|
reverse = reverse,
|
||||||
|
family = family,
|
||||||
|
text_size = text_size,
|
||||||
|
title_size = title_size,
|
||||||
|
plot_background_pal = "#FFFFFF",
|
||||||
|
panel_background_pal = "#FFFFFF",
|
||||||
|
legend_reverse = legend_rev,
|
||||||
|
void = FALSE
|
||||||
|
),
|
||||||
|
...
|
||||||
|
)
|
||||||
|
|
||||||
|
return(pl)
|
||||||
|
}
|
||||||
152
R/hbar.R
152
R/hbar.R
|
|
@ -1,152 +0,0 @@
|
||||||
#' @title Simple horizontal bar chart
|
|
||||||
#'
|
|
||||||
#' @param .tbl Some data
|
|
||||||
#' @param x Some numeric column on the x scale
|
|
||||||
#' @param y Some column on the y scale
|
|
||||||
#' @param group Some grouping categorical column, e.g. administrative areas
|
|
||||||
#' @param initiative Either "reach" or "agora" or "impact" for the color palette
|
|
||||||
#' @param palette The color palette from the initiative
|
|
||||||
#' @param width Width
|
|
||||||
#' @param x_title The x scale title. Default to empty string
|
|
||||||
#' @param y_title The y scale title. Default to empty string
|
|
||||||
#' @param group_title The group legend title. Defaut to NULL
|
|
||||||
#' @param font_family The font family. Default to "Leelawadee"
|
|
||||||
#' @param position Should the chart be stacked? Default to dodge
|
|
||||||
#' @param reverse Boolean indicating whether the color palette should be reversed
|
|
||||||
#' @param title Plot title. Default to empty string
|
|
||||||
#' @param subtitle Plot subtitle. Default to empty string
|
|
||||||
#' @param gg_theme Some ggplot2 theme
|
|
||||||
#' @param ... Other arguments to be passed to "ggblanket::gg_col"
|
|
||||||
#'
|
|
||||||
#' @return A horizontal bar chart
|
|
||||||
#'
|
|
||||||
#' @export
|
|
||||||
hbar <- function(.tbl, x, y, group = NULL, initiative = "reach", palette = "primary", width = 0.5, x_title = "", y_title = "", group_title = NULL, font_family = "Leelawadee", position = "dodge", reverse = FALSE, title = "", subtitle = "", gg_theme = NULL, ...){
|
|
||||||
|
|
||||||
|
|
||||||
if (!(initiative %in% c("reach", "agora", "impact"))) rlang::abort(c("Wrong `initiative` arg", "*" = paste0("Arg `initiative` cannot be: ", initiative), "i" = "It must be one of 'reach' or 'agora' or 'impact'"))
|
|
||||||
|
|
||||||
if (initiative == "reach") {
|
|
||||||
palette <- pal_reach(palette, reverse = reverse)
|
|
||||||
main_col <- cols_reach("main_grey")
|
|
||||||
|
|
||||||
if(is.null(palette)) rlang::warn(
|
|
||||||
c(paste0("There is no palette '", palette, "' for initiative 'reach'. Fallback to ggblanket's default color palette."),
|
|
||||||
"i" = paste0("Use `pal_reach(show_palettes = T)` to see the list of availabale palettes.")
|
|
||||||
)
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
if (initiative == "agora") {
|
|
||||||
palette <- pal_agora(palette, reverse = reverse)
|
|
||||||
main_col <- cols_agora("main_bordeaux")
|
|
||||||
|
|
||||||
|
|
||||||
if(is.null(palette)) rlang::warn(
|
|
||||||
c(paste0("There is no palette '", palette, "' for initiative 'agora'. Fallback to ggblanket's default color palette."),
|
|
||||||
"i" = paste0("Use `pal_agora(show_palettes = T)` to see the list of availabale palettes.")
|
|
||||||
)
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
if (initiative == "impact") rlang::warn("IMPACT colors are under development. Fallback to ggblanket's default.")
|
|
||||||
|
|
||||||
hbar <- .tbl |>
|
|
||||||
ggblanket::gg_col(x = {{ x }},
|
|
||||||
y = {{ y }},
|
|
||||||
col = {{ group }},
|
|
||||||
x_title = x_title,
|
|
||||||
y_title = y_title,
|
|
||||||
col_title = group_title,
|
|
||||||
alpha_fill = 1,
|
|
||||||
pal = palette,
|
|
||||||
width = width,
|
|
||||||
position = position,
|
|
||||||
stat = "identity",
|
|
||||||
title = "",
|
|
||||||
subtitle = "",
|
|
||||||
theme = gg_theme,
|
|
||||||
...
|
|
||||||
)
|
|
||||||
|
|
||||||
return(hbar)
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#' @title Simple horizontal bar chart which scales x_labels to percentages
|
|
||||||
#'
|
|
||||||
#' @param .tbl Some data
|
|
||||||
#' @param x Some numeric column on the x scale
|
|
||||||
#' @param y Some column on the y scale
|
|
||||||
#' @param group Some grouping categorical column, e.g. administrative areas
|
|
||||||
#' @param initiative Either "reach" or "agora" or "impact" for the color palette
|
|
||||||
#' @param palette The color palette from the initiative
|
|
||||||
#' @param width Width
|
|
||||||
#' @param x_title The x scale title. Default to empty string
|
|
||||||
#' @param y_title The y scale title. Default to empty string
|
|
||||||
#' @param group_title The group legend title. Defaut to NULL
|
|
||||||
#' @param font_family The font family. Default to "Leelawadee"
|
|
||||||
#' @param position Should the chart be stacked? Default to dodge
|
|
||||||
#' @param reverse Boolean indicating whether the color palette should be reversed
|
|
||||||
#' @param title Plot title. Default to empty string
|
|
||||||
#' @param subtitle Plot subtitle. Default to empty string
|
|
||||||
#' @param gg_theme Some ggplot2 theme
|
|
||||||
#' @param ... Other arguments to be passed to "ggblanket::gg_col"
|
|
||||||
#'
|
|
||||||
#' @return A horizontal bar chart
|
|
||||||
#'
|
|
||||||
#' @export
|
|
||||||
hbar_percent <- function(.tbl, x, y, group = NULL, initiative = "reach", palette = "primary", width = 0.5, x_title = "", y_title = "", group_title = NULL, font_family = "Leelawadee", position = "dodge", reverse = FALSE, title = "", subtitle = "", gg_theme = NULL, ...){
|
|
||||||
|
|
||||||
|
|
||||||
if (!(initiative %in% c("reach", "agora", "impact"))) rlang::abort(c("Wrong `initiative` arg", "*" = paste0("Arg `initiative` cannot be: ", initiative), "i" = "It must be one of 'reach' or 'agora' or 'impact'"))
|
|
||||||
|
|
||||||
if (initiative == "reach") {
|
|
||||||
palette <- pal_reach(palette, reverse = reverse)
|
|
||||||
main_col <- cols_reach("main_grey")
|
|
||||||
|
|
||||||
if(is.null(palette)) rlang::warn(
|
|
||||||
c(paste0("There is no palette '", palette, "' for initiative 'reach'. Fallback to ggblanket's default color palette."),
|
|
||||||
"i" = paste0("Use `pal_reach(show_palettes = T)` to see the list of availabale palettes.")
|
|
||||||
)
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
if (initiative == "agora") {
|
|
||||||
palette <- pal_agora(palette, reverse = reverse)
|
|
||||||
main_col <- cols_agora("main_bordeaux")
|
|
||||||
|
|
||||||
|
|
||||||
if(is.null(palette)) rlang::warn(
|
|
||||||
c(paste0("There is no palette '", palette, "' for initiative 'agora'. Fallback to ggblanket's default color palette."),
|
|
||||||
"i" = paste0("Use `pal_agora(show_palettes = T)` to see the list of availabale palettes.")
|
|
||||||
)
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
if (initiative == "impact") rlang::warn("IMPACT colors are under development. Fallback to ggblanket's default.")
|
|
||||||
|
|
||||||
hbar <- .tbl |>
|
|
||||||
ggblanket::gg_col(x = {{ x }},
|
|
||||||
y = {{ y }},
|
|
||||||
col = {{ group }},
|
|
||||||
x_title = x_title,
|
|
||||||
y_title = y_title,
|
|
||||||
col_title = group_title,
|
|
||||||
alpha_fill = 1,
|
|
||||||
pal = palette,
|
|
||||||
width = width,
|
|
||||||
x_labels = scales::percent,
|
|
||||||
position = position,
|
|
||||||
stat = "identity",
|
|
||||||
title = "",
|
|
||||||
subtitle = "",
|
|
||||||
theme = gg_theme,
|
|
||||||
...
|
|
||||||
)
|
|
||||||
|
|
||||||
return(hbar)
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -11,7 +11,6 @@
|
||||||
#' @export
|
#' @export
|
||||||
pal_reach <- function(palette = "main", reverse = FALSE, color_ramp_palette = FALSE, show_palettes = FALSE, ...) {
|
pal_reach <- function(palette = "main", reverse = FALSE, color_ramp_palette = FALSE, show_palettes = FALSE, ...) {
|
||||||
|
|
||||||
|
|
||||||
palettes_reach <- list(
|
palettes_reach <- list(
|
||||||
`main` = cols_reach("main_grey", "main_red", "main_lt_grey", "main_beige"),
|
`main` = cols_reach("main_grey", "main_red", "main_lt_grey", "main_beige"),
|
||||||
`primary` = cols_reach("main_grey", "main_red"),
|
`primary` = cols_reach("main_grey", "main_red"),
|
||||||
|
|
@ -58,7 +57,7 @@ pal_reach <- function(palette = "main", reverse = FALSE, color_ramp_palette = FA
|
||||||
if (reverse) pal <- rev(pal)
|
if (reverse) pal <- rev(pal)
|
||||||
|
|
||||||
if (color_ramp_palette) {
|
if (color_ramp_palette) {
|
||||||
rlang::check_installed("grDevices", reason = "Package \"grDevices\" needed for `pal_reach()` woth 'color_ramp_palette' set to `TRUE` to work. Please install it.")
|
rlang::check_installed("grDevices", reason = "Package \"grDevices\" needed for `pal_reach()` with 'color_ramp_palette' set to `TRUE` to work. Please install it.")
|
||||||
|
|
||||||
pal <- grDevices::colorRampPalette(pal, ...)
|
pal <- grDevices::colorRampPalette(pal, ...)
|
||||||
}
|
}
|
||||||
|
|
|
||||||
66
R/point.R
Normal file
66
R/point.R
Normal file
|
|
@ -0,0 +1,66 @@
|
||||||
|
#' @title Simple point chart
|
||||||
|
#'
|
||||||
|
#' @param df A data frame.
|
||||||
|
#' @param x A numeric column.
|
||||||
|
#' @param y A character column or coercible as a character column.
|
||||||
|
#' @param group Some grouping categorical column, e.g. administrative areas or population groups.
|
||||||
|
#' @param palette Palette name from 'pal_reach()'.
|
||||||
|
#' @param reverse Boolean indicating whether the palette should be reversed.
|
||||||
|
#' @param family The font family for all plot's texts. Default to "Leelawadee".
|
||||||
|
#' @param alpha Transparency.
|
||||||
|
#' @param size Dot size. Default to 1.5.
|
||||||
|
#' @param x_title The x scale title. Default to NULL.
|
||||||
|
#' @param y_title The y scale title. Default to NULL.
|
||||||
|
#' @param group_title The group legend title. Default to NULL.
|
||||||
|
#' @param title Plot title. Default to NULL.
|
||||||
|
#' @param subtitle Plot subtitle. Default to NULL.
|
||||||
|
#' @param caption Caption title string. Default to NULL.
|
||||||
|
#' @param text_size The size of all text other than the title, subtitle and caption. Defaults to 10.
|
||||||
|
#' @param title_size The size of the title text. Defaults to 14.
|
||||||
|
#' @param legend_position Position of the legend; Default to "right". Can take "right", "left", "top", "bottom" or "none".
|
||||||
|
#' @param void Boolean to remove all elements from the plot. Default to FALSE.
|
||||||
|
#' @param ... Other arguments to be passed to "ggblanket::gg_col"
|
||||||
|
#'
|
||||||
|
#' @description `ggblanket` as internals for deciding whether the bar chart is horizontally readable.
|
||||||
|
#'
|
||||||
|
#' @return A bar chart
|
||||||
|
#'
|
||||||
|
#' @export
|
||||||
|
point_reach <- function(df, x, y, group = NULL, palette = "main", reverse = FALSE, family = "Leelawadee", alpha = 1, size = 1.5, x_title = NULL, y_title = NULL, group_title = NULL, title = NULL, subtitle = NULL, caption = NULL, text_size = 10, title_size = 14, legend_position = "right", void = FALSE, ...){
|
||||||
|
|
||||||
|
pal <- pal_reach(palette)
|
||||||
|
|
||||||
|
if(is.null(pal)) rlang::warn(
|
||||||
|
c(paste0("There is no palette '", palette, "' for initiative 'reach'. Fallback to ggblanket's default color palette."),
|
||||||
|
"i" = paste0("Use `pal_reach(show_palettes = T)` to see the list of availabale palettes.")
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
pl <- df |>
|
||||||
|
ggblanket::gg_point(x = {{ x }},
|
||||||
|
y = {{ y }},
|
||||||
|
col = {{ group }},
|
||||||
|
x_title = x_title,
|
||||||
|
y_title = y_title,
|
||||||
|
col_title = group_title,
|
||||||
|
alpha = alpha,
|
||||||
|
size = size,
|
||||||
|
title = title,
|
||||||
|
subtitle = subtitle,
|
||||||
|
caption = caption,
|
||||||
|
col_legend_place = legend_position,
|
||||||
|
theme = theme_reach(
|
||||||
|
palette = palette,
|
||||||
|
reverse = reverse,
|
||||||
|
family = family,
|
||||||
|
text_size = text_size,
|
||||||
|
title_size = title_size,
|
||||||
|
plot_background_pal = "#FFFFFF",
|
||||||
|
panel_background_pal = "#FFFFFF",
|
||||||
|
void = FALSE
|
||||||
|
),
|
||||||
|
...
|
||||||
|
)
|
||||||
|
|
||||||
|
return(pl)
|
||||||
|
}
|
||||||
75
R/scale.R
75
R/scale.R
|
|
@ -1,15 +1,17 @@
|
||||||
#' Color scale constructor for REACH or AGORA colors
|
#' Color scale constructor for REACH or AGORA colors
|
||||||
#'
|
#'
|
||||||
#' @param initiative Either "reach" or "agora
|
#' @param initiative Either "reach" or "agora.
|
||||||
#' @param palette Palette name from `pal_reach()` or `pal_agora()`
|
#' @param palette Palette name from `pal_reach()` or `pal_agora()`.
|
||||||
#' @param discrete Boolean indicating whether color aesthetic is discrete or not
|
#' @param discrete Boolean indicating whether color aesthetic is discrete or not.
|
||||||
#' @param reverse Boolean indicating whether the palette should be reversed
|
#' @param reverse Boolean indicating whether the palette should be reversed.
|
||||||
|
#' @param reverse_guide Boolean indicating whether the guide should be reversed.
|
||||||
#' @param ... Additional arguments passed to discrete_scale() or
|
#' @param ... Additional arguments passed to discrete_scale() or
|
||||||
#' scale_color_gradient(), used respectively when discrete is TRUE or FALSE
|
#' scale_fill_gradient(), used respectively when discrete is TRUE or FALSE.
|
||||||
|
#'
|
||||||
#' @return A color scale for ggplot
|
#' @return A color scale for ggplot
|
||||||
#'
|
#'
|
||||||
#' @export
|
#' @export
|
||||||
scale_color <- function(initiative = "reach", palette = "main", discrete = TRUE, reverse = FALSE, ...) {
|
scale_color <- function(initiative = "reach", palette = "main", discrete = TRUE, reverse = FALSE, reverse_guide = TRUE, ...) {
|
||||||
|
|
||||||
if (initiative == "reach") {
|
if (initiative == "reach") {
|
||||||
pal <- pal_reach(
|
pal <- pal_reach(
|
||||||
|
|
@ -30,9 +32,28 @@ scale_color <- function(initiative = "reach", palette = "main", discrete = TRUE
|
||||||
}
|
}
|
||||||
|
|
||||||
if (discrete) {
|
if (discrete) {
|
||||||
ggplot2::discrete_scale("colour", paste0(initiative, "_", palette), palette = pal, ...)
|
ggplot2::discrete_scale(
|
||||||
|
"colour",
|
||||||
|
paste0(initiative, "_", palette),
|
||||||
|
palette = pal,
|
||||||
|
guide = ggplot2::guide_legend(
|
||||||
|
title.position = "top",
|
||||||
|
draw.ulim = TRUE,
|
||||||
|
draw.llim = TRUE,
|
||||||
|
ticks.colour = "#F1F3F5",
|
||||||
|
reverse = reverse_guide),
|
||||||
|
...)
|
||||||
} else {
|
} else {
|
||||||
ggplot2::scale_color_gradientn(colours = pal(256), ...)
|
ggplot2::scale_color_gradientn(
|
||||||
|
colours = pal(256),
|
||||||
|
guide = ggplot2::guide_colorbar(
|
||||||
|
title.position = "top",
|
||||||
|
draw.ulim = TRUE,
|
||||||
|
draw.llim = TRUE,
|
||||||
|
ticks.colour = "#F1F3F5",
|
||||||
|
reverse = reverse_guide
|
||||||
|
),
|
||||||
|
...)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -40,16 +61,18 @@ scale_color <- function(initiative = "reach", palette = "main", discrete = TRUE
|
||||||
|
|
||||||
#' Fill scale constructor for REACH or AGORA colors
|
#' Fill scale constructor for REACH or AGORA colors
|
||||||
#'
|
#'
|
||||||
#' @param initiative Either "reach" or "agora
|
#' @param initiative Either "reach" or "agora.
|
||||||
#' @param palette Palette name from `pal_reach()` or `pal_agora()`
|
#' @param palette Palette name from `pal_reach()` or `pal_agora()`.
|
||||||
#' @param discrete Boolean indicating whether color aesthetic is discrete or not
|
#' @param discrete Boolean indicating whether color aesthetic is discrete or not.
|
||||||
#' @param reverse Boolean indicating whether the palette should be reversed
|
#' @param reverse Boolean indicating whether the palette should be reversed.
|
||||||
|
#' @param reverse_guide Boolean indicating whether the guide should be reversed.
|
||||||
#' @param ... Additional arguments passed to discrete_scale() or
|
#' @param ... Additional arguments passed to discrete_scale() or
|
||||||
#' scale_fill_gradient(), used respectively when discrete is TRUE or FALSE
|
#' scale_fill_gradient(), used respectively when discrete is TRUE or FALSE.
|
||||||
#' @return A fill scale for ggplot
|
#'
|
||||||
|
#' @return A fill scale for ggplot.
|
||||||
#'
|
#'
|
||||||
#' @export
|
#' @export
|
||||||
scale_fill <- function(initiative = "reach", palette = "main", discrete = TRUE, reverse = FALSE, ...) {
|
scale_fill <- function(initiative = "reach", palette = "main", discrete = TRUE, reverse = FALSE, reverse_guide = TRUE, ...) {
|
||||||
|
|
||||||
if (initiative == "reach") {
|
if (initiative == "reach") {
|
||||||
pal <- pal_reach(
|
pal <- pal_reach(
|
||||||
|
|
@ -70,8 +93,26 @@ scale_fill <- function(initiative = "reach", palette = "main", discrete = TRUE,
|
||||||
}
|
}
|
||||||
|
|
||||||
if (discrete) {
|
if (discrete) {
|
||||||
ggplot2::discrete_scale("fill", paste0(initiative, "_", palette), palette = pal, ...)
|
ggplot2::discrete_scale(
|
||||||
|
"fill",
|
||||||
|
paste0(initiative, "_", palette),
|
||||||
|
palette = pal,
|
||||||
|
guide = ggplot2::guide_legend(
|
||||||
|
title.position = "top",
|
||||||
|
draw.ulim = TRUE,
|
||||||
|
draw.llim = TRUE,
|
||||||
|
ticks.colour = "#F1F3F5",
|
||||||
|
reverse = reverse_guide),
|
||||||
|
...)
|
||||||
} else {
|
} else {
|
||||||
ggplot2::scale_fill_gradientn(colours = pal(256), ...)
|
ggplot2::scale_fill_gradientn(
|
||||||
|
colours = pal(256),
|
||||||
|
guide = ggplot2::guide_colorbar(
|
||||||
|
title.position = "top",
|
||||||
|
draw.ulim = TRUE,
|
||||||
|
draw.llim = TRUE,
|
||||||
|
ticks.colour = "#F1F3F5",
|
||||||
|
reverse = reverse_guide),
|
||||||
|
...)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
141
R/theme_reach.R
141
R/theme_reach.R
|
|
@ -1,92 +1,69 @@
|
||||||
#' @title Base REACH ggplot2 theme
|
#' @title ggplot2 theme with REACH color palettes
|
||||||
#'
|
#'
|
||||||
#' @param family The font family. Default to "Leelawadee"
|
#' @param palette Palette name from 'pal_reach()'.
|
||||||
|
#' @param discrete Boolean indicating whether color aesthetic is discrete or not.
|
||||||
|
#' @param reverse Boolean indicating whether the palette should be reversed.
|
||||||
|
#' @param family The font family for all plot's texts. Default to "Leelawadee".
|
||||||
|
#' @param text_size The size of all text other than the title, subtitle and caption. Defaults to 10.
|
||||||
|
#' @param title_size The size of the title text_family. Defaults to 14.
|
||||||
|
#' @param plot_background_pal The color for the plot background color. Default to white.
|
||||||
|
#' @param panel_background_pal The color for the panel background color. Default to white.
|
||||||
|
#' @param legend_position Position of the legend; Default to "right". Can take "right", "left", "top", "bottom" or "none".
|
||||||
|
#' @param legend_direction Direction of the legend. Default to "vertical". Can take "vertical" or "horizontal".
|
||||||
|
#' @param legend_reverse Reverse the color in the guide? Default to TRUE.
|
||||||
|
#' @param void Boolean to remove all elements from the plot. Default to FALSE.
|
||||||
|
#' @param ... Additional arguments passed to `ggblanket::gg_theme()`.
|
||||||
#'
|
#'
|
||||||
#' @description Give some reach colors and fonts to a ggplot. Based on theme_bw()
|
#'
|
||||||
|
#' @description Give some reach colors and fonts to a ggplot.
|
||||||
#'
|
#'
|
||||||
#' @return The base REACH theme
|
#' @return The base REACH theme
|
||||||
#'
|
#'
|
||||||
#' @export
|
#' @export
|
||||||
theme_reach <- function(family = "Leelawadee") {
|
theme_reach <- function(
|
||||||
|
palette = "main",
|
||||||
|
discrete = TRUE,
|
||||||
|
reverse = FALSE,
|
||||||
|
family = "Leelawadee",
|
||||||
|
text_size = 10,
|
||||||
|
title_size = 14,
|
||||||
|
plot_background_pal = "#FFFFFF",
|
||||||
|
panel_background_pal = "#FFFFFF",
|
||||||
|
void = FALSE,
|
||||||
|
legend_position = "right",
|
||||||
|
legend_direction = "vertical",
|
||||||
|
legend_reverse = TRUE,
|
||||||
|
...
|
||||||
|
) {
|
||||||
|
|
||||||
rlang::check_installed("ggplot2", reason = "Package \"ggplot2\" needed for `theme_reach_*()` to work. Please install it.")
|
# Basic simple theme
|
||||||
|
theme_reach <- ggblanket::gg_theme(
|
||||||
|
text_family = family,
|
||||||
|
text_size = text_size,
|
||||||
|
title_size = title_size,
|
||||||
|
plot_background_pal = plot_background_pal,
|
||||||
|
panel_background_pal = panel_background_pal,
|
||||||
|
void = void
|
||||||
|
)
|
||||||
|
|
||||||
ggplot2::theme_bw() +
|
|
||||||
ggplot2::theme(
|
# Default legend to right position
|
||||||
title = ggplot2::element_text(family = family,
|
theme_reach <- theme_reach +
|
||||||
size = 12,
|
ggplot2::theme(legend.position = legend_position)
|
||||||
colour = "#58585A",
|
|
||||||
hjust = 0.5,
|
# Defaut legend to vertical direction
|
||||||
vjust = 0.5),
|
theme_reach <- theme_reach +
|
||||||
text = ggplot2::element_text(family = family,
|
ggplot2::theme(legend.direction = legend_direction)
|
||||||
colour = "#58585A"),
|
|
||||||
axis.title = ggplot2::element_text(size = 11),
|
# Add reach color palettes by default
|
||||||
axis.text = ggplot2::element_text(size = 10),
|
# (reversed guide is defaulted to TRUE for natural reading)
|
||||||
legend.text = ggplot2::element_text(size = 11),
|
theme_reach <- list(
|
||||||
strip.text = ggplot2::element_text(size = 11),
|
theme_reach,
|
||||||
legend.title = ggplot2::element_text(size = 11)
|
scale_color(palette = palette, discrete = discrete, reverse = reverse, reverse_guide = legend_reverse),
|
||||||
|
scale_fill(palette = palette, discrete = discrete, reverse = reverse, reverse_guide = legend_reverse)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
return(theme_reach)
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#' @title Some REACH theme for ggplot
|
|
||||||
#'
|
|
||||||
#' @param family The font family. Default to "Leelawadee"
|
|
||||||
#'
|
|
||||||
#' @return A theme to be added to the "+" ggplot grammar
|
|
||||||
#'
|
|
||||||
#' @export
|
|
||||||
theme_reach_borders <- function(family = "Leelawadee") {
|
|
||||||
|
|
||||||
theme_reach() +
|
|
||||||
ggplot2::theme(
|
|
||||||
panel.background = ggplot2::element_rect(colour = "white", fill = "white", size = 0.5),
|
|
||||||
strip.background = ggplot2::element_rect(linetype = "solid", colour = "#58585A", fill = "white")
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#' @title Some reach more minimal theme for a ggplot histogram
|
|
||||||
#'
|
|
||||||
#' @param family The font family. Default to "Leelawadee"
|
|
||||||
#'
|
|
||||||
#' @description Give some REACH colors and fonts to a ggplot. Based on theme_bw(). To be used for vertical bar charts.
|
|
||||||
#'
|
|
||||||
#' @return A theme to be added to the "+" ggplot grammar
|
|
||||||
#'
|
|
||||||
#' @export
|
|
||||||
theme_reach_hist <- function(family = "Leelawadee") {
|
|
||||||
|
|
||||||
theme_reach() +
|
|
||||||
ggplot2::theme(
|
|
||||||
panel.background = ggplot2::element_blank(),
|
|
||||||
strip.background = ggplot2::element_blank(),
|
|
||||||
panel.border = ggplot2::element_blank()
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
#' @title Some reach more minimal theme for a ggplot flipped histogram
|
|
||||||
#'
|
|
||||||
#' @param family The font family. Default to "Leelawadee"
|
|
||||||
#'
|
|
||||||
#' @description Give some REACH colors and fonts to a ggplot. Based on theme_bw(). To be used for horizontal bar charts.
|
|
||||||
#'
|
|
||||||
#' @return A theme to be added to the "+" ggplot grammar
|
|
||||||
#'
|
|
||||||
#' @export
|
|
||||||
theme_reach_flip_hist <- function(family = "Leelawadee") {
|
|
||||||
|
|
||||||
theme_reach() +
|
|
||||||
ggplot2::theme(
|
|
||||||
panel.background = ggplot2::element_blank(),
|
|
||||||
strip.background = ggplot2::element_blank(),
|
|
||||||
panel.border = ggplot2::element_blank(),
|
|
||||||
axis.ticks.y = ggplot2::element_blank()
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
57
README.Rmd
57
README.Rmd
|
|
@ -9,14 +9,15 @@ knitr::opts_chunk$set(
|
||||||
collapse = TRUE,
|
collapse = TRUE,
|
||||||
comment = "#>",
|
comment = "#>",
|
||||||
fig.path = "man/figures/README-",
|
fig.path = "man/figures/README-",
|
||||||
out.width = "100%"
|
out.width = "100%",
|
||||||
|
warning = FALSE,
|
||||||
|
message = FALSE
|
||||||
)
|
)
|
||||||
|
|
||||||
desc = read.dcf('DESCRIPTION')
|
desc = read.dcf('DESCRIPTION')
|
||||||
desc = setNames(as.list(desc), colnames(desc))
|
desc = setNames(as.list(desc), colnames(desc))
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
# `r desc$Package` <img src="man/figures/logo.png" align="right" alt="" width="120"/>
|
# `r desc$Package` <img src="man/figures/logo.png" align="right" alt="" width="120"/>
|
||||||
|
|
||||||
> `r desc$Title`
|
> `r desc$Title`
|
||||||
|
|
@ -50,10 +51,56 @@ Roadmap is as follows:
|
||||||
Please, do not hesitate to pull request any new viz or colors or color palettes, or to email request any change (guillaume.noblet@reach-initiative.org or gnoblet@zaclys.net).
|
Please, do not hesitate to pull request any new viz or colors or color palettes, or to email request any change (guillaume.noblet@reach-initiative.org or gnoblet@zaclys.net).
|
||||||
|
|
||||||
|
|
||||||
## Example
|
## Example 1: extracting colors
|
||||||
|
|
||||||
```{r example, eval = FALSE}
|
Color palettes for REACH, AGORA and IMPACT are available. Functions to access colors and palettes are `cols_initiative()` or `pal_initiative()`. For now, the initiative with the most colors and color palettes is REACH. Feel free to pull requests new AGORA and IMPACT colors.
|
||||||
|
|
||||||
|
```{r example-colors, eval = TRUE}
|
||||||
library(visualizeR)
|
library(visualizeR)
|
||||||
|
|
||||||
# Get all saved REACH colors, named
|
# Get all saved REACH colors, named
|
||||||
cols_reach(unnamed = F)
|
cols_reach(unnamed = F)[1:10]
|
||||||
|
|
||||||
|
# Extract a color palette as hexadecimal codes and reversed
|
||||||
|
pal_reach(palette = "main", reversed = TRUE, color_ramp_palette = FALSE)
|
||||||
|
|
||||||
|
# Get all color palettes names
|
||||||
|
pal_reach(show_palettes = T)
|
||||||
```
|
```
|
||||||
|
## Example 2: Bar chart, already REACH themed
|
||||||
|
|
||||||
|
```{r example-bar-chart, eval = TRUE}
|
||||||
|
library(visualizeR)
|
||||||
|
library(palmerpenguins)
|
||||||
|
library(dplyr)
|
||||||
|
|
||||||
|
df <- penguins |>
|
||||||
|
group_by(island, species) |>
|
||||||
|
summarize(
|
||||||
|
mean_bl = mean(bill_length_mm, na.rm = T),
|
||||||
|
mean_fl = mean(flipper_length_mm, na.rm = T)) |>
|
||||||
|
ungroup()
|
||||||
|
|
||||||
|
# Simple bar chart by group
|
||||||
|
bar_reach(df, mean_bl, island, species, percent = FALSE, x_title = "Mean of bill length")
|
||||||
|
|
||||||
|
# Using another color palette
|
||||||
|
bar_reach(df, mean_bl, island, species, percent = FALSE, palette = "artichoke_3", legend_rev = TRUE)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Example 3: Point chart, already REACH themed
|
||||||
|
|
||||||
|
At this stage, `point_reach()` only supports categorical grouping colors with the `group` arg.
|
||||||
|
|
||||||
|
```{r example-point-chart, eval = TRUE}
|
||||||
|
|
||||||
|
# Simple point chart
|
||||||
|
point_reach(penguins, bill_length_mm, flipper_length_mm)
|
||||||
|
|
||||||
|
# Point chart with grouping colors, greater dot size, some transparency, reversed color palette
|
||||||
|
point_reach(penguins, bill_length_mm, flipper_length_mm, island, alpha = 0.6, size = 3, reverse = TRUE)
|
||||||
|
|
||||||
|
# Using another color palettes
|
||||||
|
point_reach(penguins, bill_length_mm, flipper_length_mm, island, palette = "artichoke_3")
|
||||||
|
```
|
||||||
|
|
||||||
|
|
|
||||||
104
README.md
104
README.md
|
|
@ -23,14 +23,14 @@ devtools::install_github("gnoblet/visualizeR", build_vignettes = TRUE)
|
||||||
|
|
||||||
Roadmap is as follows:
|
Roadmap is as follows:
|
||||||
|
|
||||||
- [x] Add IMPACT’s colors
|
- [x] Add IMPACT’s colors
|
||||||
- [x] Add all color palettes from the internal documentation
|
- [x] Add all color palettes from the internal documentation
|
||||||
- [ ] There remains to be added more-than-7-color palettes and black
|
- [ ] There remains to be added more-than-7-color palettes and black
|
||||||
color palettes
|
color palettes
|
||||||
- [ ] Add new types of visualization (e.g. dumbbell plot)
|
- [ ] Add new types of visualization (e.g. dumbbell plot)
|
||||||
- [ ] Use examples
|
- [ ] Use examples
|
||||||
- [ ] Add some ease-map functions
|
- [ ] Add some ease-map functions
|
||||||
- [ ] Add some interactive functions (maps and graphs)
|
- [ ] Add some interactive functions (maps and graphs)
|
||||||
|
|
||||||
## Request
|
## Request
|
||||||
|
|
||||||
|
|
@ -38,10 +38,94 @@ Please, do not hesitate to pull request any new viz or colors or color
|
||||||
palettes, or to email request any change
|
palettes, or to email request any change
|
||||||
(<guillaume.noblet@reach-initiative.org> or <gnoblet@zaclys.net>).
|
(<guillaume.noblet@reach-initiative.org> or <gnoblet@zaclys.net>).
|
||||||
|
|
||||||
## Example
|
## Example 1: extracting colors
|
||||||
|
|
||||||
|
Color palettes for REACH, AGORA and IMPACT are available. Functions to
|
||||||
|
access colors and palettes are `cols_initiative()` or
|
||||||
|
`pal_initiative()`. For now, the initiative with the most colors and
|
||||||
|
color palettes is REACH. Feel free to pull requests new AGORA and IMPACT
|
||||||
|
colors.
|
||||||
|
|
||||||
``` r
|
``` r
|
||||||
library(visualizeR)
|
library(visualizeR)
|
||||||
|
|
||||||
# Get all saved REACH colors, named
|
# Get all saved REACH colors, named
|
||||||
cols_reach(unnamed = F)
|
cols_reach(unnamed = F)[1:10]
|
||||||
|
#> white black main_grey main_red main_lt_grey main_beige
|
||||||
|
#> "#FFFFFF" "#000000" "#58585A" "#EE5859" "#C7C8CA" "#D2CBB8"
|
||||||
|
#> iroise_1 iroise_2 iroise_3 iroise_4
|
||||||
|
#> "#DFECEF" "#B1D7E0" "#699DA3" "#236A7A"
|
||||||
|
|
||||||
|
# Extract a color palette as hexadecimal codes and reversed
|
||||||
|
pal_reach(palette = "main", reversed = TRUE, color_ramp_palette = FALSE)
|
||||||
|
#> [1] "#58585A" "#EE5859" "#C7C8CA" "#D2CBB8"
|
||||||
|
|
||||||
|
# Get all color palettes names
|
||||||
|
pal_reach(show_palettes = T)
|
||||||
|
#> [1] "main" "primary" "secondary" "two_dots"
|
||||||
|
#> [5] "two_dots_flashy" "red_main" "red_main_5" "red_alt"
|
||||||
|
#> [9] "red_alt_5" "iroise" "iroise_5" "discrete_6"
|
||||||
|
#> [13] "red_2" "red_3" "red_4" "red_5"
|
||||||
|
#> [17] "red_6" "red_7" "green_2" "green_3"
|
||||||
|
#> [21] "green_4" "green_5" "green_6" "green_7"
|
||||||
|
#> [25] "artichoke_2" "artichoke_3" "artichoke_4" "artichoke_5"
|
||||||
|
#> [29] "artichoke_6" "artichoke_7" "blue_2" "blue_3"
|
||||||
|
#> [33] "blue_4" "blue_5" "blue_6" "blue_7"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Example 2: Bar chart, already REACH themed
|
||||||
|
|
||||||
|
``` r
|
||||||
|
library(visualizeR)
|
||||||
|
library(palmerpenguins)
|
||||||
|
library(dplyr)
|
||||||
|
|
||||||
|
df <- penguins |>
|
||||||
|
group_by(island, species) |>
|
||||||
|
summarize(
|
||||||
|
mean_bl = mean(bill_length_mm, na.rm = T),
|
||||||
|
mean_fl = mean(flipper_length_mm, na.rm = T)) |>
|
||||||
|
ungroup()
|
||||||
|
|
||||||
|
# Simple bar chart by group
|
||||||
|
bar_reach(df, mean_bl, island, species, percent = FALSE, x_title = "Mean of bill length")
|
||||||
|
```
|
||||||
|
|
||||||
|
<img src="man/figures/README-example-bar-chart-1.png" width="100%" />
|
||||||
|
|
||||||
|
``` r
|
||||||
|
|
||||||
|
# Using another color palette
|
||||||
|
bar_reach(df, mean_bl, island, species, percent = FALSE, palette = "artichoke_3", legend_rev = TRUE)
|
||||||
|
```
|
||||||
|
|
||||||
|
<img src="man/figures/README-example-bar-chart-2.png" width="100%" />
|
||||||
|
|
||||||
|
## Example 3: Point chart, already REACH themed
|
||||||
|
|
||||||
|
At this stage, `point_reach()` only supports categorical grouping colors
|
||||||
|
with the `group` arg.
|
||||||
|
|
||||||
|
``` r
|
||||||
|
|
||||||
|
# Simple point chart
|
||||||
|
point_reach(penguins, bill_length_mm, flipper_length_mm)
|
||||||
|
```
|
||||||
|
|
||||||
|
<img src="man/figures/README-example-point-chart-1.png" width="100%" />
|
||||||
|
|
||||||
|
``` r
|
||||||
|
|
||||||
|
# Point chart with grouping colors, greater dot size, some transparency, reversed color palette
|
||||||
|
point_reach(penguins, bill_length_mm, flipper_length_mm, island, alpha = 0.6, size = 3, reverse = TRUE)
|
||||||
|
```
|
||||||
|
|
||||||
|
<img src="man/figures/README-example-point-chart-2.png" width="100%" />
|
||||||
|
|
||||||
|
``` r
|
||||||
|
|
||||||
|
# Using another color palettes
|
||||||
|
point_reach(penguins, bill_length_mm, flipper_length_mm, island, palette = "artichoke_3")
|
||||||
|
```
|
||||||
|
|
||||||
|
<img src="man/figures/README-example-point-chart-3.png" width="100%" />
|
||||||
|
|
|
||||||
|
|
@ -31,7 +31,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="https://gnoblet.github.io/visualizeR/index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="https://gnoblet.github.io/visualizeR/index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
@ -64,7 +64,7 @@
|
||||||
<div class="section level2">
|
<div class="section level2">
|
||||||
<h2 id="terms-and-conditions">TERMS AND CONDITIONS<a class="anchor" aria-label="anchor" href="#terms-and-conditions"></a></h2>
|
<h2 id="terms-and-conditions">TERMS AND CONDITIONS<a class="anchor" aria-label="anchor" href="#terms-and-conditions"></a></h2>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="0-definitions">0. Definitions<a class="anchor" aria-label="anchor" href="#0-definitions"></a></h3>
|
<h3 id="id_0-definitions">0. Definitions<a class="anchor" aria-label="anchor" href="#id_0-definitions"></a></h3>
|
||||||
<p>“This License” refers to version 3 of the GNU General Public License.</p>
|
<p>“This License” refers to version 3 of the GNU General Public License.</p>
|
||||||
<p>“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.</p>
|
<p>“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.</p>
|
||||||
<p>“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.</p>
|
<p>“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.</p>
|
||||||
|
|
@ -75,7 +75,7 @@
|
||||||
<p>An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that <strong>(1)</strong> displays an appropriate copyright notice, and <strong>(2)</strong> tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.</p>
|
<p>An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that <strong>(1)</strong> displays an appropriate copyright notice, and <strong>(2)</strong> tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="1-source-code">1. Source Code<a class="anchor" aria-label="anchor" href="#1-source-code"></a></h3>
|
<h3 id="id_1-source-code">1. Source Code<a class="anchor" aria-label="anchor" href="#id_1-source-code"></a></h3>
|
||||||
<p>The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.</p>
|
<p>The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.</p>
|
||||||
<p>A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.</p>
|
<p>A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.</p>
|
||||||
<p>The “System Libraries” of an executable work include anything, other than the work as a whole, that <strong>(a)</strong> is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and <strong>(b)</strong> serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.</p>
|
<p>The “System Libraries” of an executable work include anything, other than the work as a whole, that <strong>(a)</strong> is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and <strong>(b)</strong> serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.</p>
|
||||||
|
|
@ -84,23 +84,23 @@
|
||||||
<p>The Corresponding Source for a work in source code form is that same work.</p>
|
<p>The Corresponding Source for a work in source code form is that same work.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="2-basic-permissions">2. Basic Permissions<a class="anchor" aria-label="anchor" href="#2-basic-permissions"></a></h3>
|
<h3 id="id_2-basic-permissions">2. Basic Permissions<a class="anchor" aria-label="anchor" href="#id_2-basic-permissions"></a></h3>
|
||||||
<p>All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.</p>
|
<p>All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.</p>
|
||||||
<p>You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.</p>
|
<p>You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.</p>
|
||||||
<p>Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.</p>
|
<p>Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="3-protecting-users-legal-rights-from-anti-circumvention-law">3. Protecting Users’ Legal Rights From Anti-Circumvention Law<a class="anchor" aria-label="anchor" href="#3-protecting-users-legal-rights-from-anti-circumvention-law"></a></h3>
|
<h3 id="id_3-protecting-users-legal-rights-from-anti-circumvention-law">3. Protecting Users’ Legal Rights From Anti-Circumvention Law<a class="anchor" aria-label="anchor" href="#id_3-protecting-users-legal-rights-from-anti-circumvention-law"></a></h3>
|
||||||
<p>No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.</p>
|
<p>No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.</p>
|
||||||
<p>When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work’s users, your or third parties’ legal rights to forbid circumvention of technological measures.</p>
|
<p>When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work’s users, your or third parties’ legal rights to forbid circumvention of technological measures.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="4-conveying-verbatim-copies">4. Conveying Verbatim Copies<a class="anchor" aria-label="anchor" href="#4-conveying-verbatim-copies"></a></h3>
|
<h3 id="id_4-conveying-verbatim-copies">4. Conveying Verbatim Copies<a class="anchor" aria-label="anchor" href="#id_4-conveying-verbatim-copies"></a></h3>
|
||||||
<p>You may convey verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.</p>
|
<p>You may convey verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.</p>
|
||||||
<p>You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.</p>
|
<p>You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="5-conveying-modified-source-versions">5. Conveying Modified Source Versions<a class="anchor" aria-label="anchor" href="#5-conveying-modified-source-versions"></a></h3>
|
<h3 id="id_5-conveying-modified-source-versions">5. Conveying Modified Source Versions<a class="anchor" aria-label="anchor" href="#id_5-conveying-modified-source-versions"></a></h3>
|
||||||
<p>You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:</p>
|
<p>You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:</p>
|
||||||
<ul><li>
|
<ul><li>
|
||||||
<strong>a)</strong> The work must carry prominent notices stating that you modified it, and giving a relevant date.</li>
|
<strong>a)</strong> The work must carry prominent notices stating that you modified it, and giving a relevant date.</li>
|
||||||
|
|
@ -113,7 +113,7 @@
|
||||||
</ul><p>A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation’s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.</p>
|
</ul><p>A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation’s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="6-conveying-non-source-forms">6. Conveying Non-Source Forms<a class="anchor" aria-label="anchor" href="#6-conveying-non-source-forms"></a></h3>
|
<h3 id="id_6-conveying-non-source-forms">6. Conveying Non-Source Forms<a class="anchor" aria-label="anchor" href="#id_6-conveying-non-source-forms"></a></h3>
|
||||||
<p>You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:</p>
|
<p>You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:</p>
|
||||||
<ul><li>
|
<ul><li>
|
||||||
<strong>a)</strong> Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.</li>
|
<strong>a)</strong> Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.</li>
|
||||||
|
|
@ -133,7 +133,7 @@
|
||||||
<p>Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.</p>
|
<p>Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="7-additional-terms">7. Additional Terms<a class="anchor" aria-label="anchor" href="#7-additional-terms"></a></h3>
|
<h3 id="id_7-additional-terms">7. Additional Terms<a class="anchor" aria-label="anchor" href="#id_7-additional-terms"></a></h3>
|
||||||
<p>“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.</p>
|
<p>“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.</p>
|
||||||
<p>When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.</p>
|
<p>When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.</p>
|
||||||
<p>Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:</p>
|
<p>Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:</p>
|
||||||
|
|
@ -154,24 +154,24 @@
|
||||||
<p>Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.</p>
|
<p>Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="8-termination">8. Termination<a class="anchor" aria-label="anchor" href="#8-termination"></a></h3>
|
<h3 id="id_8-termination">8. Termination<a class="anchor" aria-label="anchor" href="#id_8-termination"></a></h3>
|
||||||
<p>You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).</p>
|
<p>You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).</p>
|
||||||
<p>However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated <strong>(a)</strong> provisionally, unless and until the copyright holder explicitly and finally terminates your license, and <strong>(b)</strong> permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.</p>
|
<p>However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated <strong>(a)</strong> provisionally, unless and until the copyright holder explicitly and finally terminates your license, and <strong>(b)</strong> permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.</p>
|
||||||
<p>Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.</p>
|
<p>Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.</p>
|
||||||
<p>Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.</p>
|
<p>Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="9-acceptance-not-required-for-having-copies">9. Acceptance Not Required for Having Copies<a class="anchor" aria-label="anchor" href="#9-acceptance-not-required-for-having-copies"></a></h3>
|
<h3 id="id_9-acceptance-not-required-for-having-copies">9. Acceptance Not Required for Having Copies<a class="anchor" aria-label="anchor" href="#id_9-acceptance-not-required-for-having-copies"></a></h3>
|
||||||
<p>You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.</p>
|
<p>You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="10-automatic-licensing-of-downstream-recipients">10. Automatic Licensing of Downstream Recipients<a class="anchor" aria-label="anchor" href="#10-automatic-licensing-of-downstream-recipients"></a></h3>
|
<h3 id="id_10-automatic-licensing-of-downstream-recipients">10. Automatic Licensing of Downstream Recipients<a class="anchor" aria-label="anchor" href="#id_10-automatic-licensing-of-downstream-recipients"></a></h3>
|
||||||
<p>Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.</p>
|
<p>Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.</p>
|
||||||
<p>An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party’s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.</p>
|
<p>An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party’s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.</p>
|
||||||
<p>You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.</p>
|
<p>You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="11-patents">11. Patents<a class="anchor" aria-label="anchor" href="#11-patents"></a></h3>
|
<h3 id="id_11-patents">11. Patents<a class="anchor" aria-label="anchor" href="#id_11-patents"></a></h3>
|
||||||
<p>A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor’s “contributor version”.</p>
|
<p>A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor’s “contributor version”.</p>
|
||||||
<p>A contributor’s “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.</p>
|
<p>A contributor’s “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.</p>
|
||||||
<p>Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor’s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.</p>
|
<p>Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor’s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.</p>
|
||||||
|
|
@ -182,30 +182,30 @@
|
||||||
<p>Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.</p>
|
<p>Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="12-no-surrender-of-others-freedom">12. No Surrender of Others’ Freedom<a class="anchor" aria-label="anchor" href="#12-no-surrender-of-others-freedom"></a></h3>
|
<h3 id="id_12-no-surrender-of-others-freedom">12. No Surrender of Others’ Freedom<a class="anchor" aria-label="anchor" href="#id_12-no-surrender-of-others-freedom"></a></h3>
|
||||||
<p>If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.</p>
|
<p>If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="13-use-with-the-gnu-affero-general-public-license">13. Use with the GNU Affero General Public License<a class="anchor" aria-label="anchor" href="#13-use-with-the-gnu-affero-general-public-license"></a></h3>
|
<h3 id="id_13-use-with-the-gnu-affero-general-public-license">13. Use with the GNU Affero General Public License<a class="anchor" aria-label="anchor" href="#id_13-use-with-the-gnu-affero-general-public-license"></a></h3>
|
||||||
<p>Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.</p>
|
<p>Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="14-revised-versions-of-this-license">14. Revised Versions of this License<a class="anchor" aria-label="anchor" href="#14-revised-versions-of-this-license"></a></h3>
|
<h3 id="id_14-revised-versions-of-this-license">14. Revised Versions of this License<a class="anchor" aria-label="anchor" href="#id_14-revised-versions-of-this-license"></a></h3>
|
||||||
<p>The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.</p>
|
<p>The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.</p>
|
||||||
<p>Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.</p>
|
<p>Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.</p>
|
||||||
<p>If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Program.</p>
|
<p>If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Program.</p>
|
||||||
<p>Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.</p>
|
<p>Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="15-disclaimer-of-warranty">15. Disclaimer of Warranty<a class="anchor" aria-label="anchor" href="#15-disclaimer-of-warranty"></a></h3>
|
<h3 id="id_15-disclaimer-of-warranty">15. Disclaimer of Warranty<a class="anchor" aria-label="anchor" href="#id_15-disclaimer-of-warranty"></a></h3>
|
||||||
<p>THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</p>
|
<p>THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="16-limitation-of-liability">16. Limitation of Liability<a class="anchor" aria-label="anchor" href="#16-limitation-of-liability"></a></h3>
|
<h3 id="id_16-limitation-of-liability">16. Limitation of Liability<a class="anchor" aria-label="anchor" href="#id_16-limitation-of-liability"></a></h3>
|
||||||
<p>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</p>
|
<p>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level3">
|
<div class="section level3">
|
||||||
<h3 id="17-interpretation-of-sections-15-and-16">17. Interpretation of Sections 15 and 16<a class="anchor" aria-label="anchor" href="#17-interpretation-of-sections-15-and-16"></a></h3>
|
<h3 id="id_17-interpretation-of-sections-15-and-16">17. Interpretation of Sections 15 and 16<a class="anchor" aria-label="anchor" href="#id_17-interpretation-of-sections-15-and-16"></a></h3>
|
||||||
<p>If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.</p>
|
<p>If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.</p>
|
||||||
<p><em>END OF TERMS AND CONDITIONS</em></p>
|
<p><em>END OF TERMS AND CONDITIONS</em></p>
|
||||||
</div>
|
</div>
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
|
||||||
|
|
@ -33,7 +33,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
@ -90,26 +90,19 @@
|
||||||
<p>Roadmap is as follows:</p>
|
<p>Roadmap is as follows:</p>
|
||||||
<ul class="task-list">
|
<ul class="task-list">
|
||||||
<li>
|
<li>
|
||||||
<input type="checkbox" disabled checked>
|
<input type="checkbox" disabled checked>Add IMPACT’s colors</li>
|
||||||
Add IMPACT’s colors</li>
|
|
||||||
<li>
|
<li>
|
||||||
<input type="checkbox" disabled checked>
|
<input type="checkbox" disabled checked>Add all color palettes from the internal documentation</li>
|
||||||
Add all color palettes from the internal documentation</li>
|
|
||||||
<li>
|
<li>
|
||||||
<input type="checkbox" disabled>
|
<input type="checkbox" disabled>There remains to be added more-than-7-color palettes and black color palettes</li>
|
||||||
There remains to be added more-than-7-color palettes and black color palettes</li>
|
|
||||||
<li>
|
<li>
|
||||||
<input type="checkbox" disabled>
|
<input type="checkbox" disabled>Add new types of visualization (e.g. dumbbell plot)</li>
|
||||||
Add new types of visualization (e.g. dumbbell plot)</li>
|
|
||||||
<li>
|
<li>
|
||||||
<input type="checkbox" disabled>
|
<input type="checkbox" disabled>Use examples</li>
|
||||||
Use examples</li>
|
|
||||||
<li>
|
<li>
|
||||||
<input type="checkbox" disabled>
|
<input type="checkbox" disabled>Add some ease-map functions</li>
|
||||||
Add some ease-map functions</li>
|
|
||||||
<li>
|
<li>
|
||||||
<input type="checkbox" disabled>
|
<input type="checkbox" disabled>Add some interactive functions (maps and graphs)</li>
|
||||||
Add some interactive functions (maps and graphs)</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
<div class="section level2">
|
<div class="section level2">
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
@ -44,6 +44,12 @@
|
||||||
<small>Source: <a href="https://github.com/gnoblet/visualizeR/blob/HEAD/NEWS.md" class="external-link"><code>NEWS.md</code></a></small>
|
<small>Source: <a href="https://github.com/gnoblet/visualizeR/blob/HEAD/NEWS.md" class="external-link"><code>NEWS.md</code></a></small>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="section level2">
|
||||||
|
<h2 class="pkg-version" data-toc-text="0.2.9000" id="visualizer-029000">visualizeR 0.2.9000<a class="anchor" aria-label="anchor" href="#visualizer-029000"></a></h2>
|
||||||
|
<ul><li>Breaking changes: almost all functions got refinements, and there are new functions, typically <code>hbar()</code> becomes <code><a href="../reference/bar_reach.html">bar_reach()</a></code> and <code><a href="../reference/point_reach.html">point_reach()</a></code> is added.</li>
|
||||||
|
<li>Following <code><a href="../reference/theme_reach.html">theme_reach()</a></code> is now used by all plotting functions.</li>
|
||||||
|
<li>Add README.md.</li>
|
||||||
|
</ul><hr></div>
|
||||||
<div class="section level2">
|
<div class="section level2">
|
||||||
<h2 class="pkg-version" data-toc-text="0.1.7.9000" id="visualizer-0179000">visualizeR 0.1.7.9000<a class="anchor" aria-label="anchor" href="#visualizer-0179000"></a></h2>
|
<h2 class="pkg-version" data-toc-text="0.1.7.9000" id="visualizer-0179000">visualizeR 0.1.7.9000<a class="anchor" aria-label="anchor" href="#visualizer-0179000"></a></h2>
|
||||||
<ul><li>Fixed some color palettes.</li>
|
<ul><li>Fixed some color palettes.</li>
|
||||||
|
|
@ -60,11 +66,11 @@
|
||||||
<div class="section level2">
|
<div class="section level2">
|
||||||
<h2 class="pkg-version" data-toc-text="0.1.4.9000" id="visualizer-0149000">visualizeR 0.1.4.9000<a class="anchor" aria-label="anchor" href="#visualizer-0149000"></a></h2>
|
<h2 class="pkg-version" data-toc-text="0.1.4.9000" id="visualizer-0149000">visualizeR 0.1.4.9000<a class="anchor" aria-label="anchor" href="#visualizer-0149000"></a></h2>
|
||||||
<ul><li>
|
<ul><li>
|
||||||
<code><a href="../reference/hbar.html">hbar()</a></code> gains a new boolean argument <code>reverse</code> to pass to <code><a href="../reference/pal_reach.html">pal_reach()</a></code> or <code><a href="../reference/pal_agora.html">pal_agora()</a></code>, indicating if the color palette should be reversed or not.</li>
|
<code>hbar()</code> gains a new boolean argument <code>reverse</code> to pass to <code><a href="../reference/pal_reach.html">pal_reach()</a></code> or <code><a href="../reference/pal_agora.html">pal_agora()</a></code>, indicating if the color palette should be reversed or not.</li>
|
||||||
</ul><hr></div>
|
</ul><hr></div>
|
||||||
<div class="section level2">
|
<div class="section level2">
|
||||||
<h2 class="pkg-version" data-toc-text="0.1.3.9000" id="visualizer-0139000">visualizeR 0.1.3.9000<a class="anchor" aria-label="anchor" href="#visualizer-0139000"></a></h2>
|
<h2 class="pkg-version" data-toc-text="0.1.3.9000" id="visualizer-0139000">visualizeR 0.1.3.9000<a class="anchor" aria-label="anchor" href="#visualizer-0139000"></a></h2>
|
||||||
<ul><li>Small change to <code><a href="../reference/hbar.html">hbar()</a></code>: removes error arg within <code><a href="https://statisticsnz.github.io/simplevis/reference/gg_hbar.html" class="external-link">simplevis::gg_hbar()</a></code> call.</li>
|
<ul><li>Small change to <code>hbar()</code>: removes error arg within <code>simplevis::gg_hbar()</code> call.</li>
|
||||||
</ul><hr></div>
|
</ul><hr></div>
|
||||||
<div class="section level2">
|
<div class="section level2">
|
||||||
<h2 class="pkg-version" data-toc-text="0.1.2.9000" id="visualizer-0129000">visualizeR 0.1.2.9000<a class="anchor" aria-label="anchor" href="#visualizer-0129000"></a></h2>
|
<h2 class="pkg-version" data-toc-text="0.1.2.9000" id="visualizer-0129000">visualizeR 0.1.2.9000<a class="anchor" aria-label="anchor" href="#visualizer-0129000"></a></h2>
|
||||||
|
|
@ -73,7 +79,7 @@
|
||||||
</ul><hr></div>
|
</ul><hr></div>
|
||||||
<div class="section level2">
|
<div class="section level2">
|
||||||
<h2 class="pkg-version" data-toc-text="0.1.1.9000" id="visualizer-0119000">visualizeR 0.1.1.9000<a class="anchor" aria-label="anchor" href="#visualizer-0119000"></a></h2>
|
<h2 class="pkg-version" data-toc-text="0.1.1.9000" id="visualizer-0119000">visualizeR 0.1.1.9000<a class="anchor" aria-label="anchor" href="#visualizer-0119000"></a></h2>
|
||||||
<ul><li>Added two horizontal bar functions: <code><a href="../reference/hbar.html">hbar()</a></code>, <code><a href="../reference/hbar_percent.html">hbar_percent()</a></code> (<a href="https://github.com/gnoblet/visualizeR/issues/3" class="external-link">#3</a>)</li>
|
<ul><li>Added two horizontal bar functions: <code>hbar()</code>, <code>hbar_percent()</code> (<a href="https://github.com/gnoblet/visualizeR/issues/3" class="external-link">#3</a>)</li>
|
||||||
<li>Added some internals to check for missing columns and bad arguments (<a href="https://github.com/gnoblet/visualizeR/issues/3" class="external-link">#3</a>)</li>
|
<li>Added some internals to check for missing columns and bad arguments (<a href="https://github.com/gnoblet/visualizeR/issues/3" class="external-link">#3</a>)</li>
|
||||||
<li>Modified some <code><a href="../reference/theme_reach.html">theme_reach()</a></code> documentation</li>
|
<li>Modified some <code><a href="../reference/theme_reach.html">theme_reach()</a></code> documentation</li>
|
||||||
<li>Add <code><a href="../reference/buffer_bbox.html">buffer_bbox()</a></code> function to produce a buffered bbox, e.g. for use with <code>tmap</code>
|
<li>Add <code><a href="../reference/buffer_bbox.html">buffer_bbox()</a></code> function to produce a buffered bbox, e.g. for use with <code>tmap</code>
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
pandoc: 2.17.1.1
|
pandoc: 2.19.2
|
||||||
pkgdown: 2.0.6
|
pkgdown: 2.0.6
|
||||||
pkgdown_sha: ~
|
pkgdown_sha: ~
|
||||||
articles: {}
|
articles: {}
|
||||||
last_built: 2022-09-19T20:16Z
|
last_built: 2022-11-20T23:06Z
|
||||||
urls:
|
urls:
|
||||||
reference: https://gnoblet.github.io/visualizeR/reference
|
reference: https://gnoblet.github.io/visualizeR/reference
|
||||||
article: https://gnoblet.github.io/visualizeR/articles
|
article: https://gnoblet.github.io/visualizeR/articles
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
|
||||||
201
docs/reference/bar_reach.html
Normal file
201
docs/reference/bar_reach.html
Normal file
|
|
@ -0,0 +1,201 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="`ggblanket` as internals for deciding whether the bar chart is horizontally readable."><title>Simple bar chart — bar_reach • visualizeR</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.1.3/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.1.3/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.rawgit.com/afeld/bootstrap-toc/v1.0.1/dist/bootstrap-toc.min.js"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Simple bar chart — bar_reach"><meta property="og:description" content="`ggblanket` as internals for deciding whether the bar chart is horizontally readable."><meta property="og:image" content="https://gnoblet.github.io/visualizeR/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
|
||||||
|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
||||||
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
||||||
|
<![endif]--></head><body>
|
||||||
|
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><div class="container">
|
||||||
|
|
||||||
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
<span class="navbar-toggler-icon"></span>
|
||||||
|
</button>
|
||||||
|
|
||||||
|
<div id="navbar" class="collapse navbar-collapse ms-3">
|
||||||
|
<ul class="navbar-nav me-auto"><li class="active nav-item">
|
||||||
|
<a class="nav-link" href="../reference/index.html">Reference</a>
|
||||||
|
</li>
|
||||||
|
<li class="nav-item">
|
||||||
|
<a class="nav-link" href="../news/index.html">Changelog</a>
|
||||||
|
</li>
|
||||||
|
</ul><form class="form-inline my-2 my-lg-0" role="search">
|
||||||
|
<input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form>
|
||||||
|
|
||||||
|
<ul class="navbar-nav"><li class="nav-item">
|
||||||
|
<a class="external-link nav-link" href="https://github.com/gnoblet/visualizeR/" aria-label="github">
|
||||||
|
<span class="fab fa fab fa-github fa-lg"></span>
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
</ul></div>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</nav><div class="container template-reference-topic">
|
||||||
|
<div class="row">
|
||||||
|
<main id="main" class="col-md-9"><div class="page-header">
|
||||||
|
<img src="../logo.png" class="logo" alt=""><h1>Simple bar chart</h1>
|
||||||
|
<small class="dont-index">Source: <a href="https://github.com/gnoblet/visualizeR/blob/HEAD/R/bar.R" class="external-link"><code>R/bar.R</code></a></small>
|
||||||
|
<div class="d-none name"><code>bar_reach.Rd</code></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="ref-description section level2">
|
||||||
|
<p>`ggblanket` as internals for deciding whether the bar chart is horizontally readable.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="section level2">
|
||||||
|
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
|
||||||
|
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">bar_reach</span><span class="op">(</span></span>
|
||||||
|
<span> <span class="va">df</span>,</span>
|
||||||
|
<span> <span class="va">x</span>,</span>
|
||||||
|
<span> <span class="va">y</span>,</span>
|
||||||
|
<span> group <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||||||
|
<span> percent <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
||||||
|
<span> palette <span class="op">=</span> <span class="st">"main"</span>,</span>
|
||||||
|
<span> reverse <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
||||||
|
<span> family <span class="op">=</span> <span class="st">"Leelawadee"</span>,</span>
|
||||||
|
<span> alpha <span class="op">=</span> <span class="fl">1</span>,</span>
|
||||||
|
<span> width <span class="op">=</span> <span class="fl">0.5</span>,</span>
|
||||||
|
<span> x_title <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||||||
|
<span> y_title <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||||||
|
<span> group_title <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||||||
|
<span> position <span class="op">=</span> <span class="st">"dodge"</span>,</span>
|
||||||
|
<span> title <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||||||
|
<span> subtitle <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||||||
|
<span> caption <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||||||
|
<span> text_size <span class="op">=</span> <span class="fl">10</span>,</span>
|
||||||
|
<span> title_size <span class="op">=</span> <span class="fl">14</span>,</span>
|
||||||
|
<span> legend_position <span class="op">=</span> <span class="st">"right"</span>,</span>
|
||||||
|
<span> legend_rev <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
||||||
|
<span> void <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
||||||
|
<span> <span class="va">...</span></span>
|
||||||
|
<span><span class="op">)</span></span></code></pre></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="section level2">
|
||||||
|
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
||||||
|
<dl><dt>df</dt>
|
||||||
|
<dd><p>A data frame.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>x</dt>
|
||||||
|
<dd><p>A numeric column.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>y</dt>
|
||||||
|
<dd><p>A character column or coercible as a character column.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>group</dt>
|
||||||
|
<dd><p>Some grouping categorical column, e.g. administrative areas or population groups.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>percent</dt>
|
||||||
|
<dd><p>TRUE or FALSE. Should the x-labels be displayed as percentages? Default to TRUE.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>palette</dt>
|
||||||
|
<dd><p>Palette name from 'pal_reach()'.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>reverse</dt>
|
||||||
|
<dd><p>Boolean indicating whether the palette should be reversed.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>family</dt>
|
||||||
|
<dd><p>The font family for all plot's texts. Default to "Leelawadee".</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>alpha</dt>
|
||||||
|
<dd><p>Transparency.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>width</dt>
|
||||||
|
<dd><p>Width.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>x_title</dt>
|
||||||
|
<dd><p>The x scale title. Default to NULL.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>y_title</dt>
|
||||||
|
<dd><p>The y scale title. Default to NULL.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>group_title</dt>
|
||||||
|
<dd><p>The group legend title. Default to NULL.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>position</dt>
|
||||||
|
<dd><p>Should the chart be stacked? Default to "dodge". Can take "dodge" and "stack".</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>title</dt>
|
||||||
|
<dd><p>Plot title. Default to NULL.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>subtitle</dt>
|
||||||
|
<dd><p>Plot subtitle. Default to NULL.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>caption</dt>
|
||||||
|
<dd><p>Caption title string. Default to NULL.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>text_size</dt>
|
||||||
|
<dd><p>The size of all text other than the title, subtitle and caption. Defaults to 10.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>title_size</dt>
|
||||||
|
<dd><p>The size of the title text. Defaults to 14.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>legend_position</dt>
|
||||||
|
<dd><p>Position of the legend; Default to "right". Can take "right", "left", "top", "bottom" or "none".</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>legend_rev</dt>
|
||||||
|
<dd><p>Reverse the color in the guide? Default to TRUE.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>void</dt>
|
||||||
|
<dd><p>Boolean to remove all elements from the plot. Default to FALSE.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>...</dt>
|
||||||
|
<dd><p>Other arguments to be passed to "ggblanket::gg_col"</p></dd>
|
||||||
|
|
||||||
|
</dl></div>
|
||||||
|
<div class="section level2">
|
||||||
|
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
||||||
|
|
||||||
|
|
||||||
|
<p>A bar chart</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
|
||||||
|
</nav></aside></div>
|
||||||
|
|
||||||
|
|
||||||
|
<footer><div class="pkgdown-footer-left">
|
||||||
|
<p></p><p>Developed by Noblet Guillaume.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="pkgdown-footer-right">
|
||||||
|
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.6.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</footer></div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</body></html>
|
||||||
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
|
||||||
|
|
@ -1,171 +0,0 @@
|
||||||
<!DOCTYPE html>
|
|
||||||
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="Simple horizontal bar chart"><title>Simple horizontal bar chart — hbar • visualizeR</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.1.3/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.1.3/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.rawgit.com/afeld/bootstrap-toc/v1.0.1/dist/bootstrap-toc.min.js"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Simple horizontal bar chart — hbar"><meta property="og:description" content="Simple horizontal bar chart"><meta property="og:image" content="https://gnoblet.github.io/visualizeR/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
|
|
||||||
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
||||||
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
||||||
<![endif]--></head><body>
|
|
||||||
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
|
||||||
|
|
||||||
|
|
||||||
<nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><div class="container">
|
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
|
||||||
<span class="navbar-toggler-icon"></span>
|
|
||||||
</button>
|
|
||||||
|
|
||||||
<div id="navbar" class="collapse navbar-collapse ms-3">
|
|
||||||
<ul class="navbar-nav me-auto"><li class="active nav-item">
|
|
||||||
<a class="nav-link" href="../reference/index.html">Reference</a>
|
|
||||||
</li>
|
|
||||||
<li class="nav-item">
|
|
||||||
<a class="nav-link" href="../news/index.html">Changelog</a>
|
|
||||||
</li>
|
|
||||||
</ul><form class="form-inline my-2 my-lg-0" role="search">
|
|
||||||
<input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form>
|
|
||||||
|
|
||||||
<ul class="navbar-nav"><li class="nav-item">
|
|
||||||
<a class="external-link nav-link" href="https://github.com/gnoblet/visualizeR/" aria-label="github">
|
|
||||||
<span class="fab fa fab fa-github fa-lg"></span>
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
</ul></div>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</nav><div class="container template-reference-topic">
|
|
||||||
<div class="row">
|
|
||||||
<main id="main" class="col-md-9"><div class="page-header">
|
|
||||||
<img src="../logo.png" class="logo" alt=""><h1>Simple horizontal bar chart</h1>
|
|
||||||
<small class="dont-index">Source: <a href="https://github.com/gnoblet/visualizeR/blob/HEAD/R/hbar.R" class="external-link"><code>R/hbar.R</code></a></small>
|
|
||||||
<div class="d-none name"><code>hbar.Rd</code></div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="ref-description section level2">
|
|
||||||
<p>Simple horizontal bar chart</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="section level2">
|
|
||||||
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
|
|
||||||
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">hbar</span><span class="op">(</span></span>
|
|
||||||
<span> <span class="va">.tbl</span>,</span>
|
|
||||||
<span> <span class="va">x</span>,</span>
|
|
||||||
<span> <span class="va">y</span>,</span>
|
|
||||||
<span> group <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
||||||
<span> initiative <span class="op">=</span> <span class="st">"reach"</span>,</span>
|
|
||||||
<span> palette <span class="op">=</span> <span class="st">"primary"</span>,</span>
|
|
||||||
<span> width <span class="op">=</span> <span class="fl">0.5</span>,</span>
|
|
||||||
<span> x_title <span class="op">=</span> <span class="st">""</span>,</span>
|
|
||||||
<span> y_title <span class="op">=</span> <span class="st">""</span>,</span>
|
|
||||||
<span> group_title <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
||||||
<span> font_family <span class="op">=</span> <span class="st">"Leelawadee"</span>,</span>
|
|
||||||
<span> position <span class="op">=</span> <span class="st">"dodge"</span>,</span>
|
|
||||||
<span> reverse <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
|
||||||
<span> title <span class="op">=</span> <span class="st">""</span>,</span>
|
|
||||||
<span> subtitle <span class="op">=</span> <span class="st">""</span>,</span>
|
|
||||||
<span> gg_theme <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
||||||
<span> <span class="va">...</span></span>
|
|
||||||
<span><span class="op">)</span></span></code></pre></div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="section level2">
|
|
||||||
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
|
||||||
<dl><dt>.tbl</dt>
|
|
||||||
<dd><p>Some data</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>x</dt>
|
|
||||||
<dd><p>Some numeric column on the x scale</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>y</dt>
|
|
||||||
<dd><p>Some column on the y scale</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>group</dt>
|
|
||||||
<dd><p>Some grouping categorical column, e.g. administrative areas</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>initiative</dt>
|
|
||||||
<dd><p>Either "reach" or "agora" or "impact" for the color palette</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>palette</dt>
|
|
||||||
<dd><p>The color palette from the initiative</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>width</dt>
|
|
||||||
<dd><p>Width</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>x_title</dt>
|
|
||||||
<dd><p>The x scale title. Default to empty string</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>y_title</dt>
|
|
||||||
<dd><p>The y scale title. Default to empty string</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>group_title</dt>
|
|
||||||
<dd><p>The group legend title. Defaut to NULL</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>font_family</dt>
|
|
||||||
<dd><p>The font family. Default to "Leelawadee"</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>position</dt>
|
|
||||||
<dd><p>Should the chart be stacked? Default to dodge</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>reverse</dt>
|
|
||||||
<dd><p>Boolean indicating whether the color palette should be reversed</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>title</dt>
|
|
||||||
<dd><p>Plot title. Default to empty string</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>subtitle</dt>
|
|
||||||
<dd><p>Plot subtitle. Default to empty string</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>gg_theme</dt>
|
|
||||||
<dd><p>Some ggplot2 theme</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>...</dt>
|
|
||||||
<dd><p>Other arguments to be passed to "ggblanket::gg_col"</p></dd>
|
|
||||||
|
|
||||||
</dl></div>
|
|
||||||
<div class="section level2">
|
|
||||||
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
|
||||||
|
|
||||||
|
|
||||||
<p>A horizontal bar chart</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
|
|
||||||
</nav></aside></div>
|
|
||||||
|
|
||||||
|
|
||||||
<footer><div class="pkgdown-footer-left">
|
|
||||||
<p></p><p>Developed by Noblet Guillaume.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="pkgdown-footer-right">
|
|
||||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.6.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</footer></div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body></html>
|
|
||||||
|
|
||||||
|
|
@ -1,171 +0,0 @@
|
||||||
<!DOCTYPE html>
|
|
||||||
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="Simple horizontal bar chart which scales x_labels to percentages"><title>Simple horizontal bar chart which scales x_labels to percentages — hbar_percent • visualizeR</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.1.3/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.1.3/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.rawgit.com/afeld/bootstrap-toc/v1.0.1/dist/bootstrap-toc.min.js"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Simple horizontal bar chart which scales x_labels to percentages — hbar_percent"><meta property="og:description" content="Simple horizontal bar chart which scales x_labels to percentages"><meta property="og:image" content="https://gnoblet.github.io/visualizeR/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
|
|
||||||
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
||||||
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
||||||
<![endif]--></head><body>
|
|
||||||
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
|
||||||
|
|
||||||
|
|
||||||
<nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><div class="container">
|
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
|
||||||
<span class="navbar-toggler-icon"></span>
|
|
||||||
</button>
|
|
||||||
|
|
||||||
<div id="navbar" class="collapse navbar-collapse ms-3">
|
|
||||||
<ul class="navbar-nav me-auto"><li class="active nav-item">
|
|
||||||
<a class="nav-link" href="../reference/index.html">Reference</a>
|
|
||||||
</li>
|
|
||||||
<li class="nav-item">
|
|
||||||
<a class="nav-link" href="../news/index.html">Changelog</a>
|
|
||||||
</li>
|
|
||||||
</ul><form class="form-inline my-2 my-lg-0" role="search">
|
|
||||||
<input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form>
|
|
||||||
|
|
||||||
<ul class="navbar-nav"><li class="nav-item">
|
|
||||||
<a class="external-link nav-link" href="https://github.com/gnoblet/visualizeR/" aria-label="github">
|
|
||||||
<span class="fab fa fab fa-github fa-lg"></span>
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
</ul></div>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</nav><div class="container template-reference-topic">
|
|
||||||
<div class="row">
|
|
||||||
<main id="main" class="col-md-9"><div class="page-header">
|
|
||||||
<img src="../logo.png" class="logo" alt=""><h1>Simple horizontal bar chart which scales x_labels to percentages</h1>
|
|
||||||
<small class="dont-index">Source: <a href="https://github.com/gnoblet/visualizeR/blob/HEAD/R/hbar.R" class="external-link"><code>R/hbar.R</code></a></small>
|
|
||||||
<div class="d-none name"><code>hbar_percent.Rd</code></div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="ref-description section level2">
|
|
||||||
<p>Simple horizontal bar chart which scales x_labels to percentages</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="section level2">
|
|
||||||
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
|
|
||||||
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">hbar_percent</span><span class="op">(</span></span>
|
|
||||||
<span> <span class="va">.tbl</span>,</span>
|
|
||||||
<span> <span class="va">x</span>,</span>
|
|
||||||
<span> <span class="va">y</span>,</span>
|
|
||||||
<span> group <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
||||||
<span> initiative <span class="op">=</span> <span class="st">"reach"</span>,</span>
|
|
||||||
<span> palette <span class="op">=</span> <span class="st">"primary"</span>,</span>
|
|
||||||
<span> width <span class="op">=</span> <span class="fl">0.5</span>,</span>
|
|
||||||
<span> x_title <span class="op">=</span> <span class="st">""</span>,</span>
|
|
||||||
<span> y_title <span class="op">=</span> <span class="st">""</span>,</span>
|
|
||||||
<span> group_title <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
||||||
<span> font_family <span class="op">=</span> <span class="st">"Leelawadee"</span>,</span>
|
|
||||||
<span> position <span class="op">=</span> <span class="st">"dodge"</span>,</span>
|
|
||||||
<span> reverse <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
|
||||||
<span> title <span class="op">=</span> <span class="st">""</span>,</span>
|
|
||||||
<span> subtitle <span class="op">=</span> <span class="st">""</span>,</span>
|
|
||||||
<span> gg_theme <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
||||||
<span> <span class="va">...</span></span>
|
|
||||||
<span><span class="op">)</span></span></code></pre></div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="section level2">
|
|
||||||
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
|
||||||
<dl><dt>.tbl</dt>
|
|
||||||
<dd><p>Some data</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>x</dt>
|
|
||||||
<dd><p>Some numeric column on the x scale</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>y</dt>
|
|
||||||
<dd><p>Some column on the y scale</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>group</dt>
|
|
||||||
<dd><p>Some grouping categorical column, e.g. administrative areas</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>initiative</dt>
|
|
||||||
<dd><p>Either "reach" or "agora" or "impact" for the color palette</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>palette</dt>
|
|
||||||
<dd><p>The color palette from the initiative</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>width</dt>
|
|
||||||
<dd><p>Width</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>x_title</dt>
|
|
||||||
<dd><p>The x scale title. Default to empty string</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>y_title</dt>
|
|
||||||
<dd><p>The y scale title. Default to empty string</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>group_title</dt>
|
|
||||||
<dd><p>The group legend title. Defaut to NULL</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>font_family</dt>
|
|
||||||
<dd><p>The font family. Default to "Leelawadee"</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>position</dt>
|
|
||||||
<dd><p>Should the chart be stacked? Default to dodge</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>reverse</dt>
|
|
||||||
<dd><p>Boolean indicating whether the color palette should be reversed</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>title</dt>
|
|
||||||
<dd><p>Plot title. Default to empty string</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>subtitle</dt>
|
|
||||||
<dd><p>Plot subtitle. Default to empty string</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>gg_theme</dt>
|
|
||||||
<dd><p>Some ggplot2 theme</p></dd>
|
|
||||||
|
|
||||||
|
|
||||||
<dt>...</dt>
|
|
||||||
<dd><p>Other arguments to be passed to "ggblanket::gg_col"</p></dd>
|
|
||||||
|
|
||||||
</dl></div>
|
|
||||||
<div class="section level2">
|
|
||||||
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
|
||||||
|
|
||||||
|
|
||||||
<p>A horizontal bar chart</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
|
|
||||||
</nav></aside></div>
|
|
||||||
|
|
||||||
|
|
||||||
<footer><div class="pkgdown-footer-left">
|
|
||||||
<p></p><p>Developed by Noblet Guillaume.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="pkgdown-footer-right">
|
|
||||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.6.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</footer></div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body></html>
|
|
||||||
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
@ -61,6 +61,11 @@
|
||||||
<dd>Abord bad argument</dd>
|
<dd>Abord bad argument</dd>
|
||||||
</dl><dl><dt>
|
</dl><dl><dt>
|
||||||
|
|
||||||
|
<code><a href="bar_reach.html">bar_reach()</a></code>
|
||||||
|
</dt>
|
||||||
|
<dd>Simple bar chart</dd>
|
||||||
|
</dl><dl><dt>
|
||||||
|
|
||||||
<code><a href="buffer_bbox.html">buffer_bbox()</a></code>
|
<code><a href="buffer_bbox.html">buffer_bbox()</a></code>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>Bbbox buffer</dd>
|
<dd>Bbbox buffer</dd>
|
||||||
|
|
@ -81,16 +86,6 @@
|
||||||
<dd>Function to extract REACH colors as hex codes</dd>
|
<dd>Function to extract REACH colors as hex codes</dd>
|
||||||
</dl><dl><dt>
|
</dl><dl><dt>
|
||||||
|
|
||||||
<code><a href="hbar.html">hbar()</a></code>
|
|
||||||
</dt>
|
|
||||||
<dd>Simple horizontal bar chart</dd>
|
|
||||||
</dl><dl><dt>
|
|
||||||
|
|
||||||
<code><a href="hbar_percent.html">hbar_percent()</a></code>
|
|
||||||
</dt>
|
|
||||||
<dd>Simple horizontal bar chart which scales x_labels to percentages</dd>
|
|
||||||
</dl><dl><dt>
|
|
||||||
|
|
||||||
<code><a href="if_not_in_stop.html">if_not_in_stop()</a></code>
|
<code><a href="if_not_in_stop.html">if_not_in_stop()</a></code>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>Stop statement "If not in colnames" with colnames</dd>
|
<dd>Stop statement "If not in colnames" with colnames</dd>
|
||||||
|
|
@ -116,6 +111,11 @@
|
||||||
<dd>Return function to interpolate a REACH color palette</dd>
|
<dd>Return function to interpolate a REACH color palette</dd>
|
||||||
</dl><dl><dt>
|
</dl><dl><dt>
|
||||||
|
|
||||||
|
<code><a href="point_reach.html">point_reach()</a></code>
|
||||||
|
</dt>
|
||||||
|
<dd>Simple point chart</dd>
|
||||||
|
</dl><dl><dt>
|
||||||
|
|
||||||
<code><a href="scale_color.html">scale_color()</a></code>
|
<code><a href="scale_color.html">scale_color()</a></code>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>Color scale constructor for REACH or AGORA colors</dd>
|
<dd>Color scale constructor for REACH or AGORA colors</dd>
|
||||||
|
|
@ -133,22 +133,7 @@
|
||||||
|
|
||||||
<code><a href="theme_reach.html">theme_reach()</a></code>
|
<code><a href="theme_reach.html">theme_reach()</a></code>
|
||||||
</dt>
|
</dt>
|
||||||
<dd>Base REACH ggplot2 theme</dd>
|
<dd>ggplot2 theme with REACH color palettes</dd>
|
||||||
</dl><dl><dt>
|
|
||||||
|
|
||||||
<code><a href="theme_reach_borders.html">theme_reach_borders()</a></code>
|
|
||||||
</dt>
|
|
||||||
<dd>Some REACH theme for ggplot</dd>
|
|
||||||
</dl><dl><dt>
|
|
||||||
|
|
||||||
<code><a href="theme_reach_flip_hist.html">theme_reach_flip_hist()</a></code>
|
|
||||||
</dt>
|
|
||||||
<dd>Some reach more minimal theme for a ggplot flipped histogram</dd>
|
|
||||||
</dl><dl><dt>
|
|
||||||
|
|
||||||
<code><a href="theme_reach_hist.html">theme_reach_hist()</a></code>
|
|
||||||
</dt>
|
|
||||||
<dd>Some reach more minimal theme for a ggplot histogram</dd>
|
|
||||||
</dl></div>
|
</dl></div>
|
||||||
</main></div>
|
</main></div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
|
||||||
186
docs/reference/point_reach.html
Normal file
186
docs/reference/point_reach.html
Normal file
|
|
@ -0,0 +1,186 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="`ggblanket` as internals for deciding whether the bar chart is horizontally readable."><title>Simple point chart — point_reach • visualizeR</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.1.3/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.1.3/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.rawgit.com/afeld/bootstrap-toc/v1.0.1/dist/bootstrap-toc.min.js"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Simple point chart — point_reach"><meta property="og:description" content="`ggblanket` as internals for deciding whether the bar chart is horizontally readable."><meta property="og:image" content="https://gnoblet.github.io/visualizeR/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
|
||||||
|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
||||||
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
||||||
|
<![endif]--></head><body>
|
||||||
|
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
||||||
|
|
||||||
|
|
||||||
|
<nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><div class="container">
|
||||||
|
|
||||||
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
<span class="navbar-toggler-icon"></span>
|
||||||
|
</button>
|
||||||
|
|
||||||
|
<div id="navbar" class="collapse navbar-collapse ms-3">
|
||||||
|
<ul class="navbar-nav me-auto"><li class="active nav-item">
|
||||||
|
<a class="nav-link" href="../reference/index.html">Reference</a>
|
||||||
|
</li>
|
||||||
|
<li class="nav-item">
|
||||||
|
<a class="nav-link" href="../news/index.html">Changelog</a>
|
||||||
|
</li>
|
||||||
|
</ul><form class="form-inline my-2 my-lg-0" role="search">
|
||||||
|
<input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form>
|
||||||
|
|
||||||
|
<ul class="navbar-nav"><li class="nav-item">
|
||||||
|
<a class="external-link nav-link" href="https://github.com/gnoblet/visualizeR/" aria-label="github">
|
||||||
|
<span class="fab fa fab fa-github fa-lg"></span>
|
||||||
|
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
</ul></div>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</nav><div class="container template-reference-topic">
|
||||||
|
<div class="row">
|
||||||
|
<main id="main" class="col-md-9"><div class="page-header">
|
||||||
|
<img src="../logo.png" class="logo" alt=""><h1>Simple point chart</h1>
|
||||||
|
<small class="dont-index">Source: <a href="https://github.com/gnoblet/visualizeR/blob/HEAD/R/point.R" class="external-link"><code>R/point.R</code></a></small>
|
||||||
|
<div class="d-none name"><code>point_reach.Rd</code></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="ref-description section level2">
|
||||||
|
<p>`ggblanket` as internals for deciding whether the bar chart is horizontally readable.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="section level2">
|
||||||
|
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
|
||||||
|
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">point_reach</span><span class="op">(</span></span>
|
||||||
|
<span> <span class="va">df</span>,</span>
|
||||||
|
<span> <span class="va">x</span>,</span>
|
||||||
|
<span> <span class="va">y</span>,</span>
|
||||||
|
<span> group <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||||||
|
<span> palette <span class="op">=</span> <span class="st">"main"</span>,</span>
|
||||||
|
<span> reverse <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
||||||
|
<span> family <span class="op">=</span> <span class="st">"Leelawadee"</span>,</span>
|
||||||
|
<span> alpha <span class="op">=</span> <span class="fl">1</span>,</span>
|
||||||
|
<span> size <span class="op">=</span> <span class="fl">1.5</span>,</span>
|
||||||
|
<span> x_title <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||||||
|
<span> y_title <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||||||
|
<span> group_title <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||||||
|
<span> title <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||||||
|
<span> subtitle <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||||||
|
<span> caption <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||||||
|
<span> text_size <span class="op">=</span> <span class="fl">10</span>,</span>
|
||||||
|
<span> title_size <span class="op">=</span> <span class="fl">14</span>,</span>
|
||||||
|
<span> legend_position <span class="op">=</span> <span class="st">"right"</span>,</span>
|
||||||
|
<span> void <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
||||||
|
<span> <span class="va">...</span></span>
|
||||||
|
<span><span class="op">)</span></span></code></pre></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="section level2">
|
||||||
|
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
||||||
|
<dl><dt>df</dt>
|
||||||
|
<dd><p>A data frame.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>x</dt>
|
||||||
|
<dd><p>A numeric column.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>y</dt>
|
||||||
|
<dd><p>A character column or coercible as a character column.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>group</dt>
|
||||||
|
<dd><p>Some grouping categorical column, e.g. administrative areas or population groups.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>palette</dt>
|
||||||
|
<dd><p>Palette name from 'pal_reach()'.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>reverse</dt>
|
||||||
|
<dd><p>Boolean indicating whether the palette should be reversed.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>family</dt>
|
||||||
|
<dd><p>The font family for all plot's texts. Default to "Leelawadee".</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>alpha</dt>
|
||||||
|
<dd><p>Transparency.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>size</dt>
|
||||||
|
<dd><p>Dot size. Default to 1.5.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>x_title</dt>
|
||||||
|
<dd><p>The x scale title. Default to NULL.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>y_title</dt>
|
||||||
|
<dd><p>The y scale title. Default to NULL.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>group_title</dt>
|
||||||
|
<dd><p>The group legend title. Default to NULL.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>title</dt>
|
||||||
|
<dd><p>Plot title. Default to NULL.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>subtitle</dt>
|
||||||
|
<dd><p>Plot subtitle. Default to NULL.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>caption</dt>
|
||||||
|
<dd><p>Caption title string. Default to NULL.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>text_size</dt>
|
||||||
|
<dd><p>The size of all text other than the title, subtitle and caption. Defaults to 10.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>title_size</dt>
|
||||||
|
<dd><p>The size of the title text. Defaults to 14.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>legend_position</dt>
|
||||||
|
<dd><p>Position of the legend; Default to "right". Can take "right", "left", "top", "bottom" or "none".</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>void</dt>
|
||||||
|
<dd><p>Boolean to remove all elements from the plot. Default to FALSE.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>...</dt>
|
||||||
|
<dd><p>Other arguments to be passed to "ggblanket::gg_col"</p></dd>
|
||||||
|
|
||||||
|
</dl></div>
|
||||||
|
<div class="section level2">
|
||||||
|
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
||||||
|
|
||||||
|
|
||||||
|
<p>A bar chart</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
|
||||||
|
</nav></aside></div>
|
||||||
|
|
||||||
|
|
||||||
|
<footer><div class="pkgdown-footer-left">
|
||||||
|
<p></p><p>Developed by Noblet Guillaume.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="pkgdown-footer-right">
|
||||||
|
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.6.</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</footer></div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</body></html>
|
||||||
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
@ -56,6 +56,7 @@
|
||||||
<span> palette <span class="op">=</span> <span class="st">"main"</span>,</span>
|
<span> palette <span class="op">=</span> <span class="st">"main"</span>,</span>
|
||||||
<span> discrete <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
<span> discrete <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
||||||
<span> reverse <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
<span> reverse <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
||||||
|
<span> reverse_guide <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
||||||
<span> <span class="va">...</span></span>
|
<span> <span class="va">...</span></span>
|
||||||
<span><span class="op">)</span></span></code></pre></div>
|
<span><span class="op">)</span></span></code></pre></div>
|
||||||
</div>
|
</div>
|
||||||
|
|
@ -63,24 +64,28 @@
|
||||||
<div class="section level2">
|
<div class="section level2">
|
||||||
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
||||||
<dl><dt>initiative</dt>
|
<dl><dt>initiative</dt>
|
||||||
<dd><p>Either "reach" or "agora</p></dd>
|
<dd><p>Either "reach" or "agora.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
<dt>palette</dt>
|
<dt>palette</dt>
|
||||||
<dd><p>Palette name from `pal_reach()` or `pal_agora()`</p></dd>
|
<dd><p>Palette name from `pal_reach()` or `pal_agora()`.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
<dt>discrete</dt>
|
<dt>discrete</dt>
|
||||||
<dd><p>Boolean indicating whether color aesthetic is discrete or not</p></dd>
|
<dd><p>Boolean indicating whether color aesthetic is discrete or not.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
<dt>reverse</dt>
|
<dt>reverse</dt>
|
||||||
<dd><p>Boolean indicating whether the palette should be reversed</p></dd>
|
<dd><p>Boolean indicating whether the palette should be reversed.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>reverse_guide</dt>
|
||||||
|
<dd><p>Boolean indicating whether the guide should be reversed.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
<dt>...</dt>
|
<dt>...</dt>
|
||||||
<dd><p>Additional arguments passed to discrete_scale() or
|
<dd><p>Additional arguments passed to discrete_scale() or
|
||||||
scale_color_gradient(), used respectively when discrete is TRUE or FALSE</p></dd>
|
scale_fill_gradient(), used respectively when discrete is TRUE or FALSE.</p></dd>
|
||||||
|
|
||||||
</dl></div>
|
</dl></div>
|
||||||
<div class="section level2">
|
<div class="section level2">
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
@ -56,6 +56,7 @@
|
||||||
<span> palette <span class="op">=</span> <span class="st">"main"</span>,</span>
|
<span> palette <span class="op">=</span> <span class="st">"main"</span>,</span>
|
||||||
<span> discrete <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
<span> discrete <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
||||||
<span> reverse <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
<span> reverse <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
||||||
|
<span> reverse_guide <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
||||||
<span> <span class="va">...</span></span>
|
<span> <span class="va">...</span></span>
|
||||||
<span><span class="op">)</span></span></code></pre></div>
|
<span><span class="op">)</span></span></code></pre></div>
|
||||||
</div>
|
</div>
|
||||||
|
|
@ -63,31 +64,35 @@
|
||||||
<div class="section level2">
|
<div class="section level2">
|
||||||
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
||||||
<dl><dt>initiative</dt>
|
<dl><dt>initiative</dt>
|
||||||
<dd><p>Either "reach" or "agora</p></dd>
|
<dd><p>Either "reach" or "agora.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
<dt>palette</dt>
|
<dt>palette</dt>
|
||||||
<dd><p>Palette name from `pal_reach()` or `pal_agora()`</p></dd>
|
<dd><p>Palette name from `pal_reach()` or `pal_agora()`.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
<dt>discrete</dt>
|
<dt>discrete</dt>
|
||||||
<dd><p>Boolean indicating whether color aesthetic is discrete or not</p></dd>
|
<dd><p>Boolean indicating whether color aesthetic is discrete or not.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
<dt>reverse</dt>
|
<dt>reverse</dt>
|
||||||
<dd><p>Boolean indicating whether the palette should be reversed</p></dd>
|
<dd><p>Boolean indicating whether the palette should be reversed.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>reverse_guide</dt>
|
||||||
|
<dd><p>Boolean indicating whether the guide should be reversed.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
<dt>...</dt>
|
<dt>...</dt>
|
||||||
<dd><p>Additional arguments passed to discrete_scale() or
|
<dd><p>Additional arguments passed to discrete_scale() or
|
||||||
scale_fill_gradient(), used respectively when discrete is TRUE or FALSE</p></dd>
|
scale_fill_gradient(), used respectively when discrete is TRUE or FALSE.</p></dd>
|
||||||
|
|
||||||
</dl></div>
|
</dl></div>
|
||||||
<div class="section level2">
|
<div class="section level2">
|
||||||
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
||||||
|
|
||||||
|
|
||||||
<p>A fill scale for ggplot</p>
|
<p>A fill scale for ggplot.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
|
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
<!DOCTYPE html>
|
<!DOCTYPE html>
|
||||||
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="Give some reach colors and fonts to a ggplot. Based on theme_bw()"><title>Base REACH ggplot2 theme — theme_reach • visualizeR</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.1.3/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.1.3/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.rawgit.com/afeld/bootstrap-toc/v1.0.1/dist/bootstrap-toc.min.js"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Base REACH ggplot2 theme — theme_reach"><meta property="og:description" content="Give some reach colors and fonts to a ggplot. Based on theme_bw()"><meta property="og:image" content="https://gnoblet.github.io/visualizeR/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
|
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="Give some reach colors and fonts to a ggplot."><title>ggplot2 theme with REACH color palettes — theme_reach • visualizeR</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.1.3/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.1.3/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.rawgit.com/afeld/bootstrap-toc/v1.0.1/dist/bootstrap-toc.min.js"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="ggplot2 theme with REACH color palettes — theme_reach"><meta property="og:description" content="Give some reach colors and fonts to a ggplot."><meta property="og:image" content="https://gnoblet.github.io/visualizeR/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
|
||||||
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
||||||
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
||||||
<![endif]--></head><body>
|
<![endif]--></head><body>
|
||||||
|
|
@ -10,7 +10,7 @@
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
|
@ -40,24 +40,86 @@
|
||||||
</nav><div class="container template-reference-topic">
|
</nav><div class="container template-reference-topic">
|
||||||
<div class="row">
|
<div class="row">
|
||||||
<main id="main" class="col-md-9"><div class="page-header">
|
<main id="main" class="col-md-9"><div class="page-header">
|
||||||
<img src="../logo.png" class="logo" alt=""><h1>Base REACH ggplot2 theme</h1>
|
<img src="../logo.png" class="logo" alt=""><h1>ggplot2 theme with REACH color palettes</h1>
|
||||||
<small class="dont-index">Source: <a href="https://github.com/gnoblet/visualizeR/blob/HEAD/R/theme_reach.R" class="external-link"><code>R/theme_reach.R</code></a></small>
|
<small class="dont-index">Source: <a href="https://github.com/gnoblet/visualizeR/blob/HEAD/R/theme_reach.R" class="external-link"><code>R/theme_reach.R</code></a></small>
|
||||||
<div class="d-none name"><code>theme_reach.Rd</code></div>
|
<div class="d-none name"><code>theme_reach.Rd</code></div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="ref-description section level2">
|
<div class="ref-description section level2">
|
||||||
<p>Give some reach colors and fonts to a ggplot. Based on theme_bw()</p>
|
<p>Give some reach colors and fonts to a ggplot.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="section level2">
|
<div class="section level2">
|
||||||
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
|
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
|
||||||
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">theme_reach</span><span class="op">(</span>family <span class="op">=</span> <span class="st">"Leelawadee"</span><span class="op">)</span></span></code></pre></div>
|
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">theme_reach</span><span class="op">(</span></span>
|
||||||
|
<span> palette <span class="op">=</span> <span class="st">"main"</span>,</span>
|
||||||
|
<span> discrete <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
||||||
|
<span> reverse <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
||||||
|
<span> family <span class="op">=</span> <span class="st">"Leelawadee"</span>,</span>
|
||||||
|
<span> text_size <span class="op">=</span> <span class="fl">10</span>,</span>
|
||||||
|
<span> title_size <span class="op">=</span> <span class="fl">14</span>,</span>
|
||||||
|
<span> plot_background_pal <span class="op">=</span> <span class="st">"#FFFFFF"</span>,</span>
|
||||||
|
<span> panel_background_pal <span class="op">=</span> <span class="st">"#FFFFFF"</span>,</span>
|
||||||
|
<span> void <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
||||||
|
<span> legend_position <span class="op">=</span> <span class="st">"right"</span>,</span>
|
||||||
|
<span> legend_direction <span class="op">=</span> <span class="st">"vertical"</span>,</span>
|
||||||
|
<span> legend_reverse <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
||||||
|
<span> <span class="va">...</span></span>
|
||||||
|
<span><span class="op">)</span></span></code></pre></div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="section level2">
|
<div class="section level2">
|
||||||
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
||||||
<dl><dt>family</dt>
|
<dl><dt>palette</dt>
|
||||||
<dd><p>The font family. Default to "Leelawadee"</p></dd>
|
<dd><p>Palette name from 'pal_reach()'.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>discrete</dt>
|
||||||
|
<dd><p>Boolean indicating whether color aesthetic is discrete or not.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>reverse</dt>
|
||||||
|
<dd><p>Boolean indicating whether the palette should be reversed.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>family</dt>
|
||||||
|
<dd><p>The font family for all plot's texts. Default to "Leelawadee".</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>text_size</dt>
|
||||||
|
<dd><p>The size of all text other than the title, subtitle and caption. Defaults to 10.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>title_size</dt>
|
||||||
|
<dd><p>The size of the title text_family. Defaults to 14.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>plot_background_pal</dt>
|
||||||
|
<dd><p>The color for the plot background color. Default to white.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>panel_background_pal</dt>
|
||||||
|
<dd><p>The color for the panel background color. Default to white.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>void</dt>
|
||||||
|
<dd><p>Boolean to remove all elements from the plot. Default to FALSE.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>legend_position</dt>
|
||||||
|
<dd><p>Position of the legend; Default to "right". Can take "right", "left", "top", "bottom" or "none".</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>legend_direction</dt>
|
||||||
|
<dd><p>Direction of the legend. Default to "vertical". Can take "vertical" or "horizontal".</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>legend_reverse</dt>
|
||||||
|
<dd><p>Reverse the color in the guide? Default to TRUE.</p></dd>
|
||||||
|
|
||||||
|
|
||||||
|
<dt>...</dt>
|
||||||
|
<dd><p>Additional arguments passed to `ggblanket::gg_theme()`.</p></dd>
|
||||||
|
|
||||||
</dl></div>
|
</dl></div>
|
||||||
<div class="section level2">
|
<div class="section level2">
|
||||||
|
|
|
||||||
|
|
@ -1,89 +0,0 @@
|
||||||
<!DOCTYPE html>
|
|
||||||
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="Some REACH theme for ggplot"><title>Some REACH theme for ggplot — theme_reach_borders • visualizeR</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.1.3/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.1.3/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.rawgit.com/afeld/bootstrap-toc/v1.0.1/dist/bootstrap-toc.min.js"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Some REACH theme for ggplot — theme_reach_borders"><meta property="og:description" content="Some REACH theme for ggplot"><meta property="og:image" content="https://gnoblet.github.io/visualizeR/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
|
|
||||||
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
||||||
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
||||||
<![endif]--></head><body>
|
|
||||||
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
|
||||||
|
|
||||||
|
|
||||||
<nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><div class="container">
|
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
|
||||||
<span class="navbar-toggler-icon"></span>
|
|
||||||
</button>
|
|
||||||
|
|
||||||
<div id="navbar" class="collapse navbar-collapse ms-3">
|
|
||||||
<ul class="navbar-nav me-auto"><li class="active nav-item">
|
|
||||||
<a class="nav-link" href="../reference/index.html">Reference</a>
|
|
||||||
</li>
|
|
||||||
<li class="nav-item">
|
|
||||||
<a class="nav-link" href="../news/index.html">Changelog</a>
|
|
||||||
</li>
|
|
||||||
</ul><form class="form-inline my-2 my-lg-0" role="search">
|
|
||||||
<input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form>
|
|
||||||
|
|
||||||
<ul class="navbar-nav"><li class="nav-item">
|
|
||||||
<a class="external-link nav-link" href="https://github.com/gnoblet/visualizeR/" aria-label="github">
|
|
||||||
<span class="fab fa fab fa-github fa-lg"></span>
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
</ul></div>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</nav><div class="container template-reference-topic">
|
|
||||||
<div class="row">
|
|
||||||
<main id="main" class="col-md-9"><div class="page-header">
|
|
||||||
<img src="../logo.png" class="logo" alt=""><h1>Some REACH theme for ggplot</h1>
|
|
||||||
<small class="dont-index">Source: <a href="https://github.com/gnoblet/visualizeR/blob/HEAD/R/theme_reach.R" class="external-link"><code>R/theme_reach.R</code></a></small>
|
|
||||||
<div class="d-none name"><code>theme_reach_borders.Rd</code></div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="ref-description section level2">
|
|
||||||
<p>Some REACH theme for ggplot</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="section level2">
|
|
||||||
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
|
|
||||||
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">theme_reach_borders</span><span class="op">(</span>family <span class="op">=</span> <span class="st">"Leelawadee"</span><span class="op">)</span></span></code></pre></div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="section level2">
|
|
||||||
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
|
||||||
<dl><dt>family</dt>
|
|
||||||
<dd><p>The font family. Default to "Leelawadee"</p></dd>
|
|
||||||
|
|
||||||
</dl></div>
|
|
||||||
<div class="section level2">
|
|
||||||
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
|
||||||
|
|
||||||
|
|
||||||
<p>A theme to be added to the "+" ggplot grammar</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
|
|
||||||
</nav></aside></div>
|
|
||||||
|
|
||||||
|
|
||||||
<footer><div class="pkgdown-footer-left">
|
|
||||||
<p></p><p>Developed by Noblet Guillaume.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="pkgdown-footer-right">
|
|
||||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.6.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</footer></div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body></html>
|
|
||||||
|
|
||||||
|
|
@ -1,89 +0,0 @@
|
||||||
<!DOCTYPE html>
|
|
||||||
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="Give some REACH colors and fonts to a ggplot. Based on theme_bw(). To be used for horizontal bar charts."><title>Some reach more minimal theme for a ggplot flipped histogram — theme_reach_flip_hist • visualizeR</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.1.3/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.1.3/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.rawgit.com/afeld/bootstrap-toc/v1.0.1/dist/bootstrap-toc.min.js"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Some reach more minimal theme for a ggplot flipped histogram — theme_reach_flip_hist"><meta property="og:description" content="Give some REACH colors and fonts to a ggplot. Based on theme_bw(). To be used for horizontal bar charts."><meta property="og:image" content="https://gnoblet.github.io/visualizeR/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
|
|
||||||
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
||||||
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
||||||
<![endif]--></head><body>
|
|
||||||
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
|
||||||
|
|
||||||
|
|
||||||
<nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><div class="container">
|
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
|
||||||
<span class="navbar-toggler-icon"></span>
|
|
||||||
</button>
|
|
||||||
|
|
||||||
<div id="navbar" class="collapse navbar-collapse ms-3">
|
|
||||||
<ul class="navbar-nav me-auto"><li class="active nav-item">
|
|
||||||
<a class="nav-link" href="../reference/index.html">Reference</a>
|
|
||||||
</li>
|
|
||||||
<li class="nav-item">
|
|
||||||
<a class="nav-link" href="../news/index.html">Changelog</a>
|
|
||||||
</li>
|
|
||||||
</ul><form class="form-inline my-2 my-lg-0" role="search">
|
|
||||||
<input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form>
|
|
||||||
|
|
||||||
<ul class="navbar-nav"><li class="nav-item">
|
|
||||||
<a class="external-link nav-link" href="https://github.com/gnoblet/visualizeR/" aria-label="github">
|
|
||||||
<span class="fab fa fab fa-github fa-lg"></span>
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
</ul></div>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</nav><div class="container template-reference-topic">
|
|
||||||
<div class="row">
|
|
||||||
<main id="main" class="col-md-9"><div class="page-header">
|
|
||||||
<img src="../logo.png" class="logo" alt=""><h1>Some reach more minimal theme for a ggplot flipped histogram</h1>
|
|
||||||
<small class="dont-index">Source: <a href="https://github.com/gnoblet/visualizeR/blob/HEAD/R/theme_reach.R" class="external-link"><code>R/theme_reach.R</code></a></small>
|
|
||||||
<div class="d-none name"><code>theme_reach_flip_hist.Rd</code></div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="ref-description section level2">
|
|
||||||
<p>Give some REACH colors and fonts to a ggplot. Based on theme_bw(). To be used for horizontal bar charts.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="section level2">
|
|
||||||
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
|
|
||||||
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">theme_reach_flip_hist</span><span class="op">(</span>family <span class="op">=</span> <span class="st">"Leelawadee"</span><span class="op">)</span></span></code></pre></div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="section level2">
|
|
||||||
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
|
||||||
<dl><dt>family</dt>
|
|
||||||
<dd><p>The font family. Default to "Leelawadee"</p></dd>
|
|
||||||
|
|
||||||
</dl></div>
|
|
||||||
<div class="section level2">
|
|
||||||
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
|
||||||
|
|
||||||
|
|
||||||
<p>A theme to be added to the "+" ggplot grammar</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
|
|
||||||
</nav></aside></div>
|
|
||||||
|
|
||||||
|
|
||||||
<footer><div class="pkgdown-footer-left">
|
|
||||||
<p></p><p>Developed by Noblet Guillaume.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="pkgdown-footer-right">
|
|
||||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.6.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</footer></div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body></html>
|
|
||||||
|
|
||||||
|
|
@ -1,89 +0,0 @@
|
||||||
<!DOCTYPE html>
|
|
||||||
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><meta name="description" content="Give some REACH colors and fonts to a ggplot. Based on theme_bw(). To be used for vertical bar charts."><title>Some reach more minimal theme for a ggplot histogram — theme_reach_hist • visualizeR</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.1.3/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.1.3/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.rawgit.com/afeld/bootstrap-toc/v1.0.1/dist/bootstrap-toc.min.js"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Some reach more minimal theme for a ggplot histogram — theme_reach_hist"><meta property="og:description" content="Give some REACH colors and fonts to a ggplot. Based on theme_bw(). To be used for vertical bar charts."><meta property="og:image" content="https://gnoblet.github.io/visualizeR/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
|
|
||||||
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
||||||
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
||||||
<![endif]--></head><body>
|
|
||||||
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
|
||||||
|
|
||||||
|
|
||||||
<nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><div class="container">
|
|
||||||
|
|
||||||
<a class="navbar-brand me-2" href="../index.html">visualizeR</a>
|
|
||||||
|
|
||||||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.7.9000</small>
|
|
||||||
|
|
||||||
|
|
||||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
|
||||||
<span class="navbar-toggler-icon"></span>
|
|
||||||
</button>
|
|
||||||
|
|
||||||
<div id="navbar" class="collapse navbar-collapse ms-3">
|
|
||||||
<ul class="navbar-nav me-auto"><li class="active nav-item">
|
|
||||||
<a class="nav-link" href="../reference/index.html">Reference</a>
|
|
||||||
</li>
|
|
||||||
<li class="nav-item">
|
|
||||||
<a class="nav-link" href="../news/index.html">Changelog</a>
|
|
||||||
</li>
|
|
||||||
</ul><form class="form-inline my-2 my-lg-0" role="search">
|
|
||||||
<input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form>
|
|
||||||
|
|
||||||
<ul class="navbar-nav"><li class="nav-item">
|
|
||||||
<a class="external-link nav-link" href="https://github.com/gnoblet/visualizeR/" aria-label="github">
|
|
||||||
<span class="fab fa fab fa-github fa-lg"></span>
|
|
||||||
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
</ul></div>
|
|
||||||
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</nav><div class="container template-reference-topic">
|
|
||||||
<div class="row">
|
|
||||||
<main id="main" class="col-md-9"><div class="page-header">
|
|
||||||
<img src="../logo.png" class="logo" alt=""><h1>Some reach more minimal theme for a ggplot histogram</h1>
|
|
||||||
<small class="dont-index">Source: <a href="https://github.com/gnoblet/visualizeR/blob/HEAD/R/theme_reach.R" class="external-link"><code>R/theme_reach.R</code></a></small>
|
|
||||||
<div class="d-none name"><code>theme_reach_hist.Rd</code></div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="ref-description section level2">
|
|
||||||
<p>Give some REACH colors and fonts to a ggplot. Based on theme_bw(). To be used for vertical bar charts.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="section level2">
|
|
||||||
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
|
|
||||||
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">theme_reach_hist</span><span class="op">(</span>family <span class="op">=</span> <span class="st">"Leelawadee"</span><span class="op">)</span></span></code></pre></div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="section level2">
|
|
||||||
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
|
||||||
<dl><dt>family</dt>
|
|
||||||
<dd><p>The font family. Default to "Leelawadee"</p></dd>
|
|
||||||
|
|
||||||
</dl></div>
|
|
||||||
<div class="section level2">
|
|
||||||
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
|
||||||
|
|
||||||
|
|
||||||
<p>A theme to be added to the "+" ggplot grammar</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
|
|
||||||
</nav></aside></div>
|
|
||||||
|
|
||||||
|
|
||||||
<footer><div class="pkgdown-footer-left">
|
|
||||||
<p></p><p>Developed by Noblet Guillaume.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="pkgdown-footer-right">
|
|
||||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.6.</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</footer></div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body></html>
|
|
||||||
|
|
||||||
File diff suppressed because one or more lines are too long
|
|
@ -3,21 +3,24 @@
|
||||||
<url>
|
<url>
|
||||||
<loc>https://gnoblet.github.io/visualizeR/404.html</loc>
|
<loc>https://gnoblet.github.io/visualizeR/404.html</loc>
|
||||||
</url>
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://gnoblet.github.io/visualizeR/LICENSE.html</loc>
|
||||||
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://gnoblet.github.io/visualizeR/authors.html</loc>
|
<loc>https://gnoblet.github.io/visualizeR/authors.html</loc>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://gnoblet.github.io/visualizeR/index.html</loc>
|
<loc>https://gnoblet.github.io/visualizeR/index.html</loc>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
|
||||||
<loc>https://gnoblet.github.io/visualizeR/LICENSE.html</loc>
|
|
||||||
</url>
|
|
||||||
<url>
|
<url>
|
||||||
<loc>https://gnoblet.github.io/visualizeR/news/index.html</loc>
|
<loc>https://gnoblet.github.io/visualizeR/news/index.html</loc>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://gnoblet.github.io/visualizeR/reference/abort_bad_argument.html</loc>
|
<loc>https://gnoblet.github.io/visualizeR/reference/abort_bad_argument.html</loc>
|
||||||
</url>
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://gnoblet.github.io/visualizeR/reference/bar_reach.html</loc>
|
||||||
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://gnoblet.github.io/visualizeR/reference/buffer_bbox.html</loc>
|
<loc>https://gnoblet.github.io/visualizeR/reference/buffer_bbox.html</loc>
|
||||||
</url>
|
</url>
|
||||||
|
|
@ -30,12 +33,6 @@
|
||||||
<url>
|
<url>
|
||||||
<loc>https://gnoblet.github.io/visualizeR/reference/cols_reach.html</loc>
|
<loc>https://gnoblet.github.io/visualizeR/reference/cols_reach.html</loc>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
|
||||||
<loc>https://gnoblet.github.io/visualizeR/reference/hbar.html</loc>
|
|
||||||
</url>
|
|
||||||
<url>
|
|
||||||
<loc>https://gnoblet.github.io/visualizeR/reference/hbar_percent.html</loc>
|
|
||||||
</url>
|
|
||||||
<url>
|
<url>
|
||||||
<loc>https://gnoblet.github.io/visualizeR/reference/if_not_in_stop.html</loc>
|
<loc>https://gnoblet.github.io/visualizeR/reference/if_not_in_stop.html</loc>
|
||||||
</url>
|
</url>
|
||||||
|
|
@ -54,6 +51,9 @@
|
||||||
<url>
|
<url>
|
||||||
<loc>https://gnoblet.github.io/visualizeR/reference/pal_reach.html</loc>
|
<loc>https://gnoblet.github.io/visualizeR/reference/pal_reach.html</loc>
|
||||||
</url>
|
</url>
|
||||||
|
<url>
|
||||||
|
<loc>https://gnoblet.github.io/visualizeR/reference/point_reach.html</loc>
|
||||||
|
</url>
|
||||||
<url>
|
<url>
|
||||||
<loc>https://gnoblet.github.io/visualizeR/reference/scale_color.html</loc>
|
<loc>https://gnoblet.github.io/visualizeR/reference/scale_color.html</loc>
|
||||||
</url>
|
</url>
|
||||||
|
|
@ -66,13 +66,4 @@
|
||||||
<url>
|
<url>
|
||||||
<loc>https://gnoblet.github.io/visualizeR/reference/theme_reach.html</loc>
|
<loc>https://gnoblet.github.io/visualizeR/reference/theme_reach.html</loc>
|
||||||
</url>
|
</url>
|
||||||
<url>
|
|
||||||
<loc>https://gnoblet.github.io/visualizeR/reference/theme_reach_borders.html</loc>
|
|
||||||
</url>
|
|
||||||
<url>
|
|
||||||
<loc>https://gnoblet.github.io/visualizeR/reference/theme_reach_flip_hist.html</loc>
|
|
||||||
</url>
|
|
||||||
<url>
|
|
||||||
<loc>https://gnoblet.github.io/visualizeR/reference/theme_reach_hist.html</loc>
|
|
||||||
</url>
|
|
||||||
</urlset>
|
</urlset>
|
||||||
|
|
|
||||||
85
man/bar_reach.Rd
Normal file
85
man/bar_reach.Rd
Normal file
|
|
@ -0,0 +1,85 @@
|
||||||
|
% Generated by roxygen2: do not edit by hand
|
||||||
|
% Please edit documentation in R/bar.R
|
||||||
|
\name{bar_reach}
|
||||||
|
\alias{bar_reach}
|
||||||
|
\title{Simple bar chart}
|
||||||
|
\usage{
|
||||||
|
bar_reach(
|
||||||
|
df,
|
||||||
|
x,
|
||||||
|
y,
|
||||||
|
group = NULL,
|
||||||
|
percent = TRUE,
|
||||||
|
palette = "main",
|
||||||
|
reverse = FALSE,
|
||||||
|
family = "Leelawadee",
|
||||||
|
alpha = 1,
|
||||||
|
width = 0.5,
|
||||||
|
x_title = NULL,
|
||||||
|
y_title = NULL,
|
||||||
|
group_title = NULL,
|
||||||
|
position = "dodge",
|
||||||
|
title = NULL,
|
||||||
|
subtitle = NULL,
|
||||||
|
caption = NULL,
|
||||||
|
text_size = 10,
|
||||||
|
title_size = 14,
|
||||||
|
legend_position = "right",
|
||||||
|
legend_rev = TRUE,
|
||||||
|
void = FALSE,
|
||||||
|
...
|
||||||
|
)
|
||||||
|
}
|
||||||
|
\arguments{
|
||||||
|
\item{df}{A data frame.}
|
||||||
|
|
||||||
|
\item{x}{A numeric column.}
|
||||||
|
|
||||||
|
\item{y}{A character column or coercible as a character column.}
|
||||||
|
|
||||||
|
\item{group}{Some grouping categorical column, e.g. administrative areas or population groups.}
|
||||||
|
|
||||||
|
\item{percent}{TRUE or FALSE. Should the x-labels be displayed as percentages? Default to TRUE.}
|
||||||
|
|
||||||
|
\item{palette}{Palette name from 'pal_reach()'.}
|
||||||
|
|
||||||
|
\item{reverse}{Boolean indicating whether the palette should be reversed.}
|
||||||
|
|
||||||
|
\item{family}{The font family for all plot's texts. Default to "Leelawadee".}
|
||||||
|
|
||||||
|
\item{alpha}{Transparency.}
|
||||||
|
|
||||||
|
\item{width}{Width.}
|
||||||
|
|
||||||
|
\item{x_title}{The x scale title. Default to NULL.}
|
||||||
|
|
||||||
|
\item{y_title}{The y scale title. Default to NULL.}
|
||||||
|
|
||||||
|
\item{group_title}{The group legend title. Default to NULL.}
|
||||||
|
|
||||||
|
\item{position}{Should the chart be stacked? Default to "dodge". Can take "dodge" and "stack".}
|
||||||
|
|
||||||
|
\item{title}{Plot title. Default to NULL.}
|
||||||
|
|
||||||
|
\item{subtitle}{Plot subtitle. Default to NULL.}
|
||||||
|
|
||||||
|
\item{caption}{Caption title string. Default to NULL.}
|
||||||
|
|
||||||
|
\item{text_size}{The size of all text other than the title, subtitle and caption. Defaults to 10.}
|
||||||
|
|
||||||
|
\item{title_size}{The size of the title text. Defaults to 14.}
|
||||||
|
|
||||||
|
\item{legend_position}{Position of the legend; Default to "right". Can take "right", "left", "top", "bottom" or "none".}
|
||||||
|
|
||||||
|
\item{legend_rev}{Reverse the color in the guide? Default to TRUE.}
|
||||||
|
|
||||||
|
\item{void}{Boolean to remove all elements from the plot. Default to FALSE.}
|
||||||
|
|
||||||
|
\item{...}{Other arguments to be passed to "ggblanket::gg_col"}
|
||||||
|
}
|
||||||
|
\value{
|
||||||
|
A bar chart
|
||||||
|
}
|
||||||
|
\description{
|
||||||
|
`ggblanket` as internals for deciding whether the bar chart is horizontally readable.
|
||||||
|
}
|
||||||
BIN
man/figures/README-example-bar-chart-1.png
Normal file
BIN
man/figures/README-example-bar-chart-1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
BIN
man/figures/README-example-bar-chart-2.png
Normal file
BIN
man/figures/README-example-bar-chart-2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
BIN
man/figures/README-example-point-chart-1.png
Normal file
BIN
man/figures/README-example-point-chart-1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
BIN
man/figures/README-example-point-chart-2.png
Normal file
BIN
man/figures/README-example-point-chart-2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 71 KiB |
BIN
man/figures/README-example-point-chart-3.png
Normal file
BIN
man/figures/README-example-point-chart-3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 44 KiB |
67
man/hbar.Rd
67
man/hbar.Rd
|
|
@ -1,67 +0,0 @@
|
||||||
% Generated by roxygen2: do not edit by hand
|
|
||||||
% Please edit documentation in R/hbar.R
|
|
||||||
\name{hbar}
|
|
||||||
\alias{hbar}
|
|
||||||
\title{Simple horizontal bar chart}
|
|
||||||
\usage{
|
|
||||||
hbar(
|
|
||||||
.tbl,
|
|
||||||
x,
|
|
||||||
y,
|
|
||||||
group = NULL,
|
|
||||||
initiative = "reach",
|
|
||||||
palette = "primary",
|
|
||||||
width = 0.5,
|
|
||||||
x_title = "",
|
|
||||||
y_title = "",
|
|
||||||
group_title = NULL,
|
|
||||||
font_family = "Leelawadee",
|
|
||||||
position = "dodge",
|
|
||||||
reverse = FALSE,
|
|
||||||
title = "",
|
|
||||||
subtitle = "",
|
|
||||||
gg_theme = NULL,
|
|
||||||
...
|
|
||||||
)
|
|
||||||
}
|
|
||||||
\arguments{
|
|
||||||
\item{.tbl}{Some data}
|
|
||||||
|
|
||||||
\item{x}{Some numeric column on the x scale}
|
|
||||||
|
|
||||||
\item{y}{Some column on the y scale}
|
|
||||||
|
|
||||||
\item{group}{Some grouping categorical column, e.g. administrative areas}
|
|
||||||
|
|
||||||
\item{initiative}{Either "reach" or "agora" or "impact" for the color palette}
|
|
||||||
|
|
||||||
\item{palette}{The color palette from the initiative}
|
|
||||||
|
|
||||||
\item{width}{Width}
|
|
||||||
|
|
||||||
\item{x_title}{The x scale title. Default to empty string}
|
|
||||||
|
|
||||||
\item{y_title}{The y scale title. Default to empty string}
|
|
||||||
|
|
||||||
\item{group_title}{The group legend title. Defaut to NULL}
|
|
||||||
|
|
||||||
\item{font_family}{The font family. Default to "Leelawadee"}
|
|
||||||
|
|
||||||
\item{position}{Should the chart be stacked? Default to dodge}
|
|
||||||
|
|
||||||
\item{reverse}{Boolean indicating whether the color palette should be reversed}
|
|
||||||
|
|
||||||
\item{title}{Plot title. Default to empty string}
|
|
||||||
|
|
||||||
\item{subtitle}{Plot subtitle. Default to empty string}
|
|
||||||
|
|
||||||
\item{gg_theme}{Some ggplot2 theme}
|
|
||||||
|
|
||||||
\item{...}{Other arguments to be passed to "ggblanket::gg_col"}
|
|
||||||
}
|
|
||||||
\value{
|
|
||||||
A horizontal bar chart
|
|
||||||
}
|
|
||||||
\description{
|
|
||||||
Simple horizontal bar chart
|
|
||||||
}
|
|
||||||
|
|
@ -1,67 +0,0 @@
|
||||||
% Generated by roxygen2: do not edit by hand
|
|
||||||
% Please edit documentation in R/hbar.R
|
|
||||||
\name{hbar_percent}
|
|
||||||
\alias{hbar_percent}
|
|
||||||
\title{Simple horizontal bar chart which scales x_labels to percentages}
|
|
||||||
\usage{
|
|
||||||
hbar_percent(
|
|
||||||
.tbl,
|
|
||||||
x,
|
|
||||||
y,
|
|
||||||
group = NULL,
|
|
||||||
initiative = "reach",
|
|
||||||
palette = "primary",
|
|
||||||
width = 0.5,
|
|
||||||
x_title = "",
|
|
||||||
y_title = "",
|
|
||||||
group_title = NULL,
|
|
||||||
font_family = "Leelawadee",
|
|
||||||
position = "dodge",
|
|
||||||
reverse = FALSE,
|
|
||||||
title = "",
|
|
||||||
subtitle = "",
|
|
||||||
gg_theme = NULL,
|
|
||||||
...
|
|
||||||
)
|
|
||||||
}
|
|
||||||
\arguments{
|
|
||||||
\item{.tbl}{Some data}
|
|
||||||
|
|
||||||
\item{x}{Some numeric column on the x scale}
|
|
||||||
|
|
||||||
\item{y}{Some column on the y scale}
|
|
||||||
|
|
||||||
\item{group}{Some grouping categorical column, e.g. administrative areas}
|
|
||||||
|
|
||||||
\item{initiative}{Either "reach" or "agora" or "impact" for the color palette}
|
|
||||||
|
|
||||||
\item{palette}{The color palette from the initiative}
|
|
||||||
|
|
||||||
\item{width}{Width}
|
|
||||||
|
|
||||||
\item{x_title}{The x scale title. Default to empty string}
|
|
||||||
|
|
||||||
\item{y_title}{The y scale title. Default to empty string}
|
|
||||||
|
|
||||||
\item{group_title}{The group legend title. Defaut to NULL}
|
|
||||||
|
|
||||||
\item{font_family}{The font family. Default to "Leelawadee"}
|
|
||||||
|
|
||||||
\item{position}{Should the chart be stacked? Default to dodge}
|
|
||||||
|
|
||||||
\item{reverse}{Boolean indicating whether the color palette should be reversed}
|
|
||||||
|
|
||||||
\item{title}{Plot title. Default to empty string}
|
|
||||||
|
|
||||||
\item{subtitle}{Plot subtitle. Default to empty string}
|
|
||||||
|
|
||||||
\item{gg_theme}{Some ggplot2 theme}
|
|
||||||
|
|
||||||
\item{...}{Other arguments to be passed to "ggblanket::gg_col"}
|
|
||||||
}
|
|
||||||
\value{
|
|
||||||
A horizontal bar chart
|
|
||||||
}
|
|
||||||
\description{
|
|
||||||
Simple horizontal bar chart which scales x_labels to percentages
|
|
||||||
}
|
|
||||||
76
man/point_reach.Rd
Normal file
76
man/point_reach.Rd
Normal file
|
|
@ -0,0 +1,76 @@
|
||||||
|
% Generated by roxygen2: do not edit by hand
|
||||||
|
% Please edit documentation in R/point.R
|
||||||
|
\name{point_reach}
|
||||||
|
\alias{point_reach}
|
||||||
|
\title{Simple point chart}
|
||||||
|
\usage{
|
||||||
|
point_reach(
|
||||||
|
df,
|
||||||
|
x,
|
||||||
|
y,
|
||||||
|
group = NULL,
|
||||||
|
palette = "main",
|
||||||
|
reverse = FALSE,
|
||||||
|
family = "Leelawadee",
|
||||||
|
alpha = 1,
|
||||||
|
size = 1.5,
|
||||||
|
x_title = NULL,
|
||||||
|
y_title = NULL,
|
||||||
|
group_title = NULL,
|
||||||
|
title = NULL,
|
||||||
|
subtitle = NULL,
|
||||||
|
caption = NULL,
|
||||||
|
text_size = 10,
|
||||||
|
title_size = 14,
|
||||||
|
legend_position = "right",
|
||||||
|
void = FALSE,
|
||||||
|
...
|
||||||
|
)
|
||||||
|
}
|
||||||
|
\arguments{
|
||||||
|
\item{df}{A data frame.}
|
||||||
|
|
||||||
|
\item{x}{A numeric column.}
|
||||||
|
|
||||||
|
\item{y}{A character column or coercible as a character column.}
|
||||||
|
|
||||||
|
\item{group}{Some grouping categorical column, e.g. administrative areas or population groups.}
|
||||||
|
|
||||||
|
\item{palette}{Palette name from 'pal_reach()'.}
|
||||||
|
|
||||||
|
\item{reverse}{Boolean indicating whether the palette should be reversed.}
|
||||||
|
|
||||||
|
\item{family}{The font family for all plot's texts. Default to "Leelawadee".}
|
||||||
|
|
||||||
|
\item{alpha}{Transparency.}
|
||||||
|
|
||||||
|
\item{size}{Dot size. Default to 1.5.}
|
||||||
|
|
||||||
|
\item{x_title}{The x scale title. Default to NULL.}
|
||||||
|
|
||||||
|
\item{y_title}{The y scale title. Default to NULL.}
|
||||||
|
|
||||||
|
\item{group_title}{The group legend title. Default to NULL.}
|
||||||
|
|
||||||
|
\item{title}{Plot title. Default to NULL.}
|
||||||
|
|
||||||
|
\item{subtitle}{Plot subtitle. Default to NULL.}
|
||||||
|
|
||||||
|
\item{caption}{Caption title string. Default to NULL.}
|
||||||
|
|
||||||
|
\item{text_size}{The size of all text other than the title, subtitle and caption. Defaults to 10.}
|
||||||
|
|
||||||
|
\item{title_size}{The size of the title text. Defaults to 14.}
|
||||||
|
|
||||||
|
\item{legend_position}{Position of the legend; Default to "right". Can take "right", "left", "top", "bottom" or "none".}
|
||||||
|
|
||||||
|
\item{void}{Boolean to remove all elements from the plot. Default to FALSE.}
|
||||||
|
|
||||||
|
\item{...}{Other arguments to be passed to "ggblanket::gg_col"}
|
||||||
|
}
|
||||||
|
\value{
|
||||||
|
A bar chart
|
||||||
|
}
|
||||||
|
\description{
|
||||||
|
`ggblanket` as internals for deciding whether the bar chart is horizontally readable.
|
||||||
|
}
|
||||||
|
|
@ -9,20 +9,23 @@ scale_color(
|
||||||
palette = "main",
|
palette = "main",
|
||||||
discrete = TRUE,
|
discrete = TRUE,
|
||||||
reverse = FALSE,
|
reverse = FALSE,
|
||||||
|
reverse_guide = TRUE,
|
||||||
...
|
...
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{initiative}{Either "reach" or "agora}
|
\item{initiative}{Either "reach" or "agora.}
|
||||||
|
|
||||||
\item{palette}{Palette name from `pal_reach()` or `pal_agora()`}
|
\item{palette}{Palette name from `pal_reach()` or `pal_agora()`.}
|
||||||
|
|
||||||
\item{discrete}{Boolean indicating whether color aesthetic is discrete or not}
|
\item{discrete}{Boolean indicating whether color aesthetic is discrete or not.}
|
||||||
|
|
||||||
\item{reverse}{Boolean indicating whether the palette should be reversed}
|
\item{reverse}{Boolean indicating whether the palette should be reversed.}
|
||||||
|
|
||||||
|
\item{reverse_guide}{Boolean indicating whether the guide should be reversed.}
|
||||||
|
|
||||||
\item{...}{Additional arguments passed to discrete_scale() or
|
\item{...}{Additional arguments passed to discrete_scale() or
|
||||||
scale_color_gradient(), used respectively when discrete is TRUE or FALSE}
|
scale_fill_gradient(), used respectively when discrete is TRUE or FALSE.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
A color scale for ggplot
|
A color scale for ggplot
|
||||||
|
|
|
||||||
|
|
@ -9,23 +9,26 @@ scale_fill(
|
||||||
palette = "main",
|
palette = "main",
|
||||||
discrete = TRUE,
|
discrete = TRUE,
|
||||||
reverse = FALSE,
|
reverse = FALSE,
|
||||||
|
reverse_guide = TRUE,
|
||||||
...
|
...
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{initiative}{Either "reach" or "agora}
|
\item{initiative}{Either "reach" or "agora.}
|
||||||
|
|
||||||
\item{palette}{Palette name from `pal_reach()` or `pal_agora()`}
|
\item{palette}{Palette name from `pal_reach()` or `pal_agora()`.}
|
||||||
|
|
||||||
\item{discrete}{Boolean indicating whether color aesthetic is discrete or not}
|
\item{discrete}{Boolean indicating whether color aesthetic is discrete or not.}
|
||||||
|
|
||||||
\item{reverse}{Boolean indicating whether the palette should be reversed}
|
\item{reverse}{Boolean indicating whether the palette should be reversed.}
|
||||||
|
|
||||||
|
\item{reverse_guide}{Boolean indicating whether the guide should be reversed.}
|
||||||
|
|
||||||
\item{...}{Additional arguments passed to discrete_scale() or
|
\item{...}{Additional arguments passed to discrete_scale() or
|
||||||
scale_fill_gradient(), used respectively when discrete is TRUE or FALSE}
|
scale_fill_gradient(), used respectively when discrete is TRUE or FALSE.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
A fill scale for ggplot
|
A fill scale for ggplot.
|
||||||
}
|
}
|
||||||
\description{
|
\description{
|
||||||
Fill scale constructor for REACH or AGORA colors
|
Fill scale constructor for REACH or AGORA colors
|
||||||
|
|
|
||||||
|
|
@ -2,16 +2,54 @@
|
||||||
% Please edit documentation in R/theme_reach.R
|
% Please edit documentation in R/theme_reach.R
|
||||||
\name{theme_reach}
|
\name{theme_reach}
|
||||||
\alias{theme_reach}
|
\alias{theme_reach}
|
||||||
\title{Base REACH ggplot2 theme}
|
\title{ggplot2 theme with REACH color palettes}
|
||||||
\usage{
|
\usage{
|
||||||
theme_reach(family = "Leelawadee")
|
theme_reach(
|
||||||
|
palette = "main",
|
||||||
|
discrete = TRUE,
|
||||||
|
reverse = FALSE,
|
||||||
|
family = "Leelawadee",
|
||||||
|
text_size = 10,
|
||||||
|
title_size = 14,
|
||||||
|
plot_background_pal = "#FFFFFF",
|
||||||
|
panel_background_pal = "#FFFFFF",
|
||||||
|
void = FALSE,
|
||||||
|
legend_position = "right",
|
||||||
|
legend_direction = "vertical",
|
||||||
|
legend_reverse = TRUE,
|
||||||
|
...
|
||||||
|
)
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{family}{The font family. Default to "Leelawadee"}
|
\item{palette}{Palette name from 'pal_reach()'.}
|
||||||
|
|
||||||
|
\item{discrete}{Boolean indicating whether color aesthetic is discrete or not.}
|
||||||
|
|
||||||
|
\item{reverse}{Boolean indicating whether the palette should be reversed.}
|
||||||
|
|
||||||
|
\item{family}{The font family for all plot's texts. Default to "Leelawadee".}
|
||||||
|
|
||||||
|
\item{text_size}{The size of all text other than the title, subtitle and caption. Defaults to 10.}
|
||||||
|
|
||||||
|
\item{title_size}{The size of the title text_family. Defaults to 14.}
|
||||||
|
|
||||||
|
\item{plot_background_pal}{The color for the plot background color. Default to white.}
|
||||||
|
|
||||||
|
\item{panel_background_pal}{The color for the panel background color. Default to white.}
|
||||||
|
|
||||||
|
\item{void}{Boolean to remove all elements from the plot. Default to FALSE.}
|
||||||
|
|
||||||
|
\item{legend_position}{Position of the legend; Default to "right". Can take "right", "left", "top", "bottom" or "none".}
|
||||||
|
|
||||||
|
\item{legend_direction}{Direction of the legend. Default to "vertical". Can take "vertical" or "horizontal".}
|
||||||
|
|
||||||
|
\item{legend_reverse}{Reverse the color in the guide? Default to TRUE.}
|
||||||
|
|
||||||
|
\item{...}{Additional arguments passed to `ggblanket::gg_theme()`.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
The base REACH theme
|
The base REACH theme
|
||||||
}
|
}
|
||||||
\description{
|
\description{
|
||||||
Give some reach colors and fonts to a ggplot. Based on theme_bw()
|
Give some reach colors and fonts to a ggplot.
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
% Generated by roxygen2: do not edit by hand
|
|
||||||
% Please edit documentation in R/theme_reach.R
|
|
||||||
\name{theme_reach_borders}
|
|
||||||
\alias{theme_reach_borders}
|
|
||||||
\title{Some REACH theme for ggplot}
|
|
||||||
\usage{
|
|
||||||
theme_reach_borders(family = "Leelawadee")
|
|
||||||
}
|
|
||||||
\arguments{
|
|
||||||
\item{family}{The font family. Default to "Leelawadee"}
|
|
||||||
}
|
|
||||||
\value{
|
|
||||||
A theme to be added to the "+" ggplot grammar
|
|
||||||
}
|
|
||||||
\description{
|
|
||||||
Some REACH theme for ggplot
|
|
||||||
}
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
% Generated by roxygen2: do not edit by hand
|
|
||||||
% Please edit documentation in R/theme_reach.R
|
|
||||||
\name{theme_reach_flip_hist}
|
|
||||||
\alias{theme_reach_flip_hist}
|
|
||||||
\title{Some reach more minimal theme for a ggplot flipped histogram}
|
|
||||||
\usage{
|
|
||||||
theme_reach_flip_hist(family = "Leelawadee")
|
|
||||||
}
|
|
||||||
\arguments{
|
|
||||||
\item{family}{The font family. Default to "Leelawadee"}
|
|
||||||
}
|
|
||||||
\value{
|
|
||||||
A theme to be added to the "+" ggplot grammar
|
|
||||||
}
|
|
||||||
\description{
|
|
||||||
Give some REACH colors and fonts to a ggplot. Based on theme_bw(). To be used for horizontal bar charts.
|
|
||||||
}
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
% Generated by roxygen2: do not edit by hand
|
|
||||||
% Please edit documentation in R/theme_reach.R
|
|
||||||
\name{theme_reach_hist}
|
|
||||||
\alias{theme_reach_hist}
|
|
||||||
\title{Some reach more minimal theme for a ggplot histogram}
|
|
||||||
\usage{
|
|
||||||
theme_reach_hist(family = "Leelawadee")
|
|
||||||
}
|
|
||||||
\arguments{
|
|
||||||
\item{family}{The font family. Default to "Leelawadee"}
|
|
||||||
}
|
|
||||||
\value{
|
|
||||||
A theme to be added to the "+" ggplot grammar
|
|
||||||
}
|
|
||||||
\description{
|
|
||||||
Give some REACH colors and fonts to a ggplot. Based on theme_bw(). To be used for vertical bar charts.
|
|
||||||
}
|
|
||||||
Loading…
Add table
Reference in a new issue