Skip to content

Add default aesthetic values to geom docs #5461

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Add default aesthetic values to geom docs #5461

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0b17937
Add default aesthetic values to all geom docs
steveharoz Oct 8, 2023
c25b23f
stylize default aesthetic value in docs
steveharoz Oct 9, 2023
cb07d94
default values in docs: edge cases for color
steveharoz Oct 10, 2023
17a77bd
default values in docs: italic "or"
steveharoz Oct 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 76 additions & 2 deletions R/utilities-help.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ rd_aesthetics <- function(type, name, extra_note = NULL) {
"@section Aesthetics:",
paste0(
"\\code{", type, "_", name, "()} ",
"understands the following aesthetics (required aesthetics are in bold):"
"understands the following aesthetics. Required aesthetics are displayed in bold and optional aesthetics list their default values."
),
"\\itemize{",
paste0(" \\item ", aes),
Expand All @@ -21,6 +21,75 @@ rd_aesthetics <- function(type, name, extra_note = NULL) {
)
}

# make the default value of an aesthetic displayable in the docs
rd_default_value_by_aesthetic <- function(aes, obj) {
default_value <- obj$default_aes[aes]

get_shape_name <- function(value) {
# copied from geom-point.R
pch_table <- c(
"square open" = 0,
"circle open" = 1,
"triangle open" = 2,
"plus" = 3,
"cross" = 4,
"diamond open" = 5,
"triangle down open" = 6,
"square cross" = 7,
"asterisk" = 8,
"diamond plus" = 9,
"circle plus" = 10,
"star" = 11,
"square plus" = 12,
"circle cross" = 13,
"square triangle" = 14,
"triangle square" = 14,
"square" = 15,
"circle small" = 16,
"triangle" = 17,
"diamond" = 18,
"circle" = 19,
"bullet" = 20,
"circle filled" = 21,
"square filled" = 22,
"diamond filled" = 23,
"triangle filled" = 24,
"triangle down filled" = 25
)
name <- names(pch_table)[pch_table==value]
glue('\\code{{{value}}} \\emph{{or}} \\code{{"{name}"}}')
}

get_linetype_name <- function(value) {
linetype_table <- c(blank = 0, solid = 1, dashed = 2, dotted = 3, dotdash = 4, longdash = 5, twodash = 6)
value = value[[1]]

ifelse(is.numeric(value), glue('\\code{{{value}}} \\emph{{or}} \\code{{"{names(linetype_table)[linetype_table==value]}"}}'),
ifelse(value %in% names(linetype_table), glue('\\code{{{linetype_table[value]}}} \\emph{{or}} \\code{{"{value}"}}'),
glue('\\code{{"{value}"}}')))
}

get_styled_color = function(value) {
if(is.na(value) || value == "transparent" || substring(as.character(value), 1, 1) == "~")
return(glue('\\code{{{value}}}'))

hex_string <- alpha(value)
color <- col2rgb(value)
text_color_string <- ifelse(sum(color * c(0.299, 0.587, 0.114)) < 128, "#FFFFFF", "#000000")

# do not use \\code{} because it will override the text color settings
glue('"<span style="color:{text_color_string}; background:{hex_string}; font-family:\'Lucida Console\', monospace !important;">{value}</span>"')
}

ifelse(aes == "shape", get_shape_name(default_value),
ifelse(aes == "linetype", get_linetype_name(default_value),
ifelse(aes %in% c("colour", "fill", "border_colour"),
ifelse(is.na(default_value), '\\code{{NA}} (equivalent to \\code{"transparent"})', get_styled_color(default_value)),
ifelse(aes == "alpha" & is.na(default_value), '\\code{NA} (equivalent to \\code{1})',
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for nitpicking this, but alpha(x, NA) is not equivalent to alpha(x, 1). Using alpha(x, NA) preserves the alpha channel, whereas alpha(x, 1) does not.

library(scales)
alpha("#FF000088", NA)
#> [1] "#FF000088"
alpha("#FF000088", 1)
#> [1] "#FF0000FF"

Created on 2023-10-27 with reprex v2.0.2

ifelse(is.character(default_value[[1]]), glue('\\code{{"{default_value}"}}'),
glue('\\code{{{as.character(default_value)}}}'))))))
}

rd_aesthetics_item <- function(x) {
req <- x$required_aes
req <- sub("|", "} \\emph{or} \\code{", req, fixed = TRUE)
Expand All @@ -29,9 +98,14 @@ rd_aesthetics_item <- function(x) {
all <- union(req, sort(optional_aes))
docs <- rd_match_docpage(all)

default_values <- ifelse(all %in% names(x$default_aes),
paste0(": ", sapply(all, rd_default_value_by_aesthetic, obj=x)),
""
)

item <- ifelse(all %in% req,
paste0("\\strong{\\code{", docs, "}}"),
paste0("\\code{", docs, "}")
paste0("\\code{", docs, "}", default_values)
)
}

Expand Down