21 changed files with 214 additions and 212 deletions
@ -1,191 +1,191 @@ |
|||||
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typography |
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typography |
||||
#' |
#' |
||||
#' Also has a "dark" / "modern" version for the new RStudio theme |
#' Also has a "dark" / "modern" version for the new RStudio theme |
||||
#' |
#' |
||||
#' @md |
#' @md |
||||
#' @section Why Arial Narrow?: |
#' @section Why Arial Narrow?: |
||||
#' First and foremost, Arial Narrow is generally installed by default or readily |
#' First and foremost, Arial Narrow is generally installed by default or readily |
||||
#' available on any modern system, so it's "free"-ish; plus, it is a condensed font |
#' available on any modern system, so it's "free"-ish; plus, it is a condensed font |
||||
#' with solid default kerning pairs and geometric numbers. |
#' with solid default kerning pairs and geometric numbers. |
||||
#' |
#' |
||||
#' @section Building upon `theme_ipsum`: |
#' @section Building upon `theme_ipsum`: |
||||
#' The function is setup in such a way that you can customize your own one by just |
#' The function is setup in such a way that you can customize your own one by just |
||||
#' wrapping the call and changing the parameters. See source for examples. |
#' wrapping the call and changing the parameters. See source for examples. |
||||
#' |
#' |
||||
#' @section Gotchas: |
#' @section Gotchas: |
||||
#' There are distinctions between font names and various devices. Names that work |
#' There are distinctions between font names and various devices. Names that work |
||||
#' for display graphics devices and bitmap ones such as `png` may not work well |
#' for display graphics devices and bitmap ones such as `png` may not work well |
||||
#' for PostScript or PDF ones. You may need two versions of a font-based |
#' for PostScript or PDF ones. You may need two versions of a font-based |
||||
#' theme function for them to work in a particular situation. This situation |
#' theme function for them to work in a particular situation. This situation |
||||
#' usually only arises when using a newer font with many weights but somewhat |
#' usually only arises when using a newer font with many weights but somewhat |
||||
#' irregular internal font name patterns. |
#' irregular internal font name patterns. |
||||
#' |
#' |
||||
#' There is an option `hrbrthemes.loadfonts` which -- if set to `TRUE` -- will |
#' There is an option `hrbrthemes.loadfonts` which -- if set to `TRUE` -- will |
||||
#' call `extrafont::loadfonts()` to register non-core fonts with R PDF & PostScript |
#' call `extrafont::loadfonts()` to register non-core fonts with R PDF & PostScript |
||||
#' devices. If you are running under Windows, the package calls the same function |
#' devices. If you are running under Windows, the package calls the same function |
||||
#' to register non-core fonts with the Windows graphics device. |
#' to register non-core fonts with the Windows graphics device. |
||||
#' |
#' |
||||
#' @md |
#' @md |
||||
#' @param base_family,base_size base font family and size |
#' @param base_family,base_size base font family and size |
||||
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot title family, face, size and margi |
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot title family, face, size and margi |
||||
#' @param subtitle_family,subtitle_face,subtitle_size plot subtitle family, face and size |
#' @param subtitle_family,subtitle_face,subtitle_size plot subtitle family, face and size |
||||
#' @param subtitle_margin plot subtitle margin bottom (single numeric value) |
#' @param subtitle_margin plot subtitle margin bottom (single numeric value) |
||||
#' @param strip_text_family,strip_text_face,strip_text_size facet label font family, face and size |
#' @param strip_text_family,strip_text_face,strip_text_size facet label font family, face and size |
||||
#' @param caption_family,caption_face,caption_size,caption_margin plot caption family, face, size and margin |
#' @param caption_family,caption_face,caption_size,caption_margin plot caption family, face, size and margin |
||||
#' @param axis_title_family,axis_title_face,axis_title_size axis title font family, face and size |
#' @param axis_title_family,axis_title_face,axis_title_size axis title font family, face and size |
||||
#' @param axis_title_just axis title font justification, one of `[blmcrt]` |
#' @param axis_title_just axis title font justification, one of `[blmcrt]` |
||||
#' @param plot_margin plot margin (specify with [ggplot2::margin()]) |
#' @param plot_margin plot margin (specify with `ggplot2::margin()`) |
||||
#' @param grid_col,axis_col grid & axis colors; both default to `#cccccc` |
#' @param grid_col,axis_col grid & axis colors; both default to `#cccccc` |
||||
#' @param grid panel grid (`TRUE`, `FALSE`, or a combination of `X`, `x`, `Y`, `y`) |
#' @param grid panel grid (`TRUE`, `FALSE`, or a combination of `X`, `x`, `Y`, `y`) |
||||
#' @param axis_text_size font size of axis text |
#' @param axis_text_size font size of axis text |
||||
#' @param axis add x or y axes? `TRUE`, `FALSE`, "`xy`" |
#' @param axis add x or y axes? `TRUE`, `FALSE`, "`xy`" |
||||
#' @param ticks ticks if `TRUE` add ticks |
#' @param ticks ticks if `TRUE` add ticks |
||||
#' @export |
#' @export |
||||
#' @examples \dontrun{ |
#' @examples \dontrun{ |
||||
#' library(ggplot2) |
#' library(ggplot2) |
||||
#' library(dplyr) |
#' library(dplyr) |
||||
#' |
#' |
||||
#' # seminal scatterplot |
#' # seminal scatterplot |
||||
#' ggplot(mtcars, aes(mpg, wt)) + |
#' ggplot(mtcars, aes(mpg, wt)) + |
||||
#' geom_point() + |
#' geom_point() + |
||||
#' labs(x="Fuel effiiency (mpg)", y="Weight (tons)", |
#' labs(x="Fuel effiiency (mpg)", y="Weight (tons)", |
||||
#' title="Seminal ggplot2 scatterplot example", |
#' title="Seminal ggplot2 scatterplot example", |
||||
#' subtitle="A plot that is only useful for demonstration purposes", |
#' subtitle="A plot that is only useful for demonstration purposes", |
||||
#' caption="Brought to you by the letter 'g'") + |
#' caption="Brought to you by the letter 'g'") + |
||||
#' theme_ipsum() |
#' theme_ipsum() |
||||
#' |
#' |
||||
#' # seminal bar chart |
#' # seminal bar chart |
||||
#' |
#' |
||||
#' update_geom_font_defaults() |
#' update_geom_font_defaults() |
||||
#' |
#' |
||||
#' count(mpg, class) %>% |
#' count(mpg, class) %>% |
||||
#' ggplot(aes(class, n)) + |
#' ggplot(aes(class, n)) + |
||||
#' geom_col() + |
#' geom_col() + |
||||
#' geom_text(aes(label=n), nudge_y=3) + |
#' geom_text(aes(label=n), nudge_y=3) + |
||||
#' labs(x="Fuel efficiency (mpg)", y="Weight (tons)", |
#' labs(x="Fuel efficiency (mpg)", y="Weight (tons)", |
||||
#' title="Seminal ggplot2 bar chart example", |
#' title="Seminal ggplot2 bar chart example", |
||||
#' subtitle="A plot that is only useful for demonstration purposes", |
#' subtitle="A plot that is only useful for demonstration purposes", |
||||
#' caption="Brought to you by the letter 'g'") + |
#' caption="Brought to you by the letter 'g'") + |
||||
#' theme_ipsum(grid="Y") + |
#' theme_ipsum(grid="Y") + |
||||
#' theme(axis.text.y=element_blank()) |
#' theme(axis.text.y=element_blank()) |
||||
#' } |
#' } |
||||
theme_ipsum <- function(base_family="Arial Narrow", base_size = 11.5, |
theme_ipsum <- function(base_family="Arial Narrow", base_size = 11.5, |
||||
plot_title_family=base_family, plot_title_size = 18, |
plot_title_family=base_family, plot_title_size = 18, |
||||
plot_title_face="bold", plot_title_margin = 10, |
plot_title_face="bold", plot_title_margin = 10, |
||||
subtitle_family=base_family, subtitle_size = 12, |
subtitle_family=base_family, subtitle_size = 12, |
||||
subtitle_face = "plain", subtitle_margin = 15, |
subtitle_face = "plain", subtitle_margin = 15, |
||||
strip_text_family = base_family, strip_text_size = 12, |
strip_text_family = base_family, strip_text_size = 12, |
||||
strip_text_face = "plain", |
strip_text_face = "plain", |
||||
caption_family = base_family, caption_size = 9, |
caption_family = base_family, caption_size = 9, |
||||
caption_face = "italic", caption_margin = 10, |
caption_face = "italic", caption_margin = 10, |
||||
axis_text_size = base_size, |
axis_text_size = base_size, |
||||
axis_title_family = subtitle_family, axis_title_size = 9, |
axis_title_family = subtitle_family, axis_title_size = 9, |
||||
axis_title_face = "plain", axis_title_just = "rt", |
axis_title_face = "plain", axis_title_just = "rt", |
||||
plot_margin = margin(30, 30, 30, 30), |
plot_margin = margin(30, 30, 30, 30), |
||||
grid_col = "#cccccc", grid = TRUE, |
grid_col = "#cccccc", grid = TRUE, |
||||
axis_col = "#cccccc", axis = FALSE, ticks = FALSE) { |
axis_col = "#cccccc", axis = FALSE, ticks = FALSE) { |
||||
|
|
||||
ret <- ggplot2::theme_minimal(base_family=base_family, base_size=base_size) |
ret <- ggplot2::theme_minimal(base_family=base_family, base_size=base_size) |
||||
|
|
||||
ret <- ret + theme(legend.background=element_blank()) |
ret <- ret + theme(legend.background=element_blank()) |
||||
ret <- ret + theme(legend.key=element_blank()) |
ret <- ret + theme(legend.key=element_blank()) |
||||
|
|
||||
if (inherits(grid, "character") | grid == TRUE) { |
if (inherits(grid, "character") | grid == TRUE) { |
||||
|
|
||||
ret <- ret + theme(panel.grid=element_line(color=grid_col, size=0.2)) |
ret <- ret + theme(panel.grid=element_line(color=grid_col, size=0.2)) |
||||
ret <- ret + theme(panel.grid.major=element_line(color=grid_col, size=0.2)) |
ret <- ret + theme(panel.grid.major=element_line(color=grid_col, size=0.2)) |
||||
ret <- ret + theme(panel.grid.minor=element_line(color=grid_col, size=0.15)) |
ret <- ret + theme(panel.grid.minor=element_line(color=grid_col, size=0.15)) |
||||
|
|
||||
if (inherits(grid, "character")) { |
if (inherits(grid, "character")) { |
||||
if (regexpr("X", grid)[1] < 0) ret <- ret + theme(panel.grid.major.x=element_blank()) |
if (regexpr("X", grid)[1] < 0) ret <- ret + theme(panel.grid.major.x=element_blank()) |
||||
if (regexpr("Y", grid)[1] < 0) ret <- ret + theme(panel.grid.major.y=element_blank()) |
if (regexpr("Y", grid)[1] < 0) ret <- ret + theme(panel.grid.major.y=element_blank()) |
||||
if (regexpr("x", grid)[1] < 0) ret <- ret + theme(panel.grid.minor.x=element_blank()) |
if (regexpr("x", grid)[1] < 0) ret <- ret + theme(panel.grid.minor.x=element_blank()) |
||||
if (regexpr("y", grid)[1] < 0) ret <- ret + theme(panel.grid.minor.y=element_blank()) |
if (regexpr("y", grid)[1] < 0) ret <- ret + theme(panel.grid.minor.y=element_blank()) |
||||
} |
} |
||||
|
|
||||
} else { |
} else { |
||||
ret <- ret + theme(panel.grid=element_blank()) |
ret <- ret + theme(panel.grid=element_blank()) |
||||
} |
} |
||||
|
|
||||
if (inherits(axis, "character") | axis == TRUE) { |
if (inherits(axis, "character") | axis == TRUE) { |
||||
ret <- ret + theme(axis.line=element_line(color="#2b2b2b", size=0.15)) |
ret <- ret + theme(axis.line=element_line(color="#2b2b2b", size=0.15)) |
||||
if (inherits(axis, "character")) { |
if (inherits(axis, "character")) { |
||||
axis <- tolower(axis) |
axis <- tolower(axis) |
||||
if (regexpr("x", axis)[1] < 0) { |
if (regexpr("x", axis)[1] < 0) { |
||||
ret <- ret + theme(axis.line.x=element_blank()) |
ret <- ret + theme(axis.line.x=element_blank()) |
||||
} else { |
} else { |
||||
ret <- ret + theme(axis.line.x=element_line(color=axis_col, size=0.15)) |
ret <- ret + theme(axis.line.x=element_line(color=axis_col, size=0.15)) |
||||
} |
} |
||||
if (regexpr("y", axis)[1] < 0) { |
if (regexpr("y", axis)[1] < 0) { |
||||
ret <- ret + theme(axis.line.y=element_blank()) |
ret <- ret + theme(axis.line.y=element_blank()) |
||||
} else { |
} else { |
||||
ret <- ret + theme(axis.line.y=element_line(color=axis_col, size=0.15)) |
ret <- ret + theme(axis.line.y=element_line(color=axis_col, size=0.15)) |
||||
} |
} |
||||
} else { |
} else { |
||||
ret <- ret + theme(axis.line.x=element_line(color=axis_col, size=0.15)) |
ret <- ret + theme(axis.line.x=element_line(color=axis_col, size=0.15)) |
||||
ret <- ret + theme(axis.line.y=element_line(color=axis_col, size=0.15)) |
ret <- ret + theme(axis.line.y=element_line(color=axis_col, size=0.15)) |
||||
} |
} |
||||
} else { |
} else { |
||||
ret <- ret + theme(axis.line=element_blank()) |
ret <- ret + theme(axis.line=element_blank()) |
||||
} |
} |
||||
|
|
||||
if (!ticks) { |
if (!ticks) { |
||||
ret <- ret + theme(axis.ticks = element_blank()) |
ret <- ret + theme(axis.ticks = element_blank()) |
||||
ret <- ret + theme(axis.ticks.x = element_blank()) |
ret <- ret + theme(axis.ticks.x = element_blank()) |
||||
ret <- ret + theme(axis.ticks.y = element_blank()) |
ret <- ret + theme(axis.ticks.y = element_blank()) |
||||
} else { |
} else { |
||||
ret <- ret + theme(axis.ticks = element_line(size=0.15)) |
ret <- ret + theme(axis.ticks = element_line(size=0.15)) |
||||
ret <- ret + theme(axis.ticks.x = element_line(size=0.15)) |
ret <- ret + theme(axis.ticks.x = element_line(size=0.15)) |
||||
ret <- ret + theme(axis.ticks.y = element_line(size=0.15)) |
ret <- ret + theme(axis.ticks.y = element_line(size=0.15)) |
||||
ret <- ret + theme(axis.ticks.length = grid::unit(5, "pt")) |
ret <- ret + theme(axis.ticks.length = grid::unit(5, "pt")) |
||||
} |
} |
||||
|
|
||||
xj <- switch(tolower(substr(axis_title_just, 1, 1)), b=0, l=0, m=0.5, c=0.5, r=1, t=1) |
xj <- switch(tolower(substr(axis_title_just, 1, 1)), b=0, l=0, m=0.5, c=0.5, r=1, t=1) |
||||
yj <- switch(tolower(substr(axis_title_just, 2, 2)), b=0, l=0, m=0.5, c=0.5, r=1, t=1) |
yj <- switch(tolower(substr(axis_title_just, 2, 2)), b=0, l=0, m=0.5, c=0.5, r=1, t=1) |
||||
|
|
||||
ret <- ret + theme(axis.text.x=element_text(size=axis_text_size, margin=margin(t=0))) |
ret <- ret + theme(axis.text.x=element_text(size=axis_text_size, margin=margin(t=0))) |
||||
ret <- ret + theme(axis.text.y=element_text(size=axis_text_size, margin=margin(r=0))) |
ret <- ret + theme(axis.text.y=element_text(size=axis_text_size, margin=margin(r=0))) |
||||
ret <- ret + theme(axis.title=element_text(size=axis_title_size, family=axis_title_family)) |
ret <- ret + theme(axis.title=element_text(size=axis_title_size, family=axis_title_family)) |
||||
ret <- ret + theme(axis.title.x=element_text(hjust=xj, size=axis_title_size, |
ret <- ret + theme(axis.title.x=element_text(hjust=xj, size=axis_title_size, |
||||
family=axis_title_family, face=axis_title_face)) |
family=axis_title_family, face=axis_title_face)) |
||||
ret <- ret + theme(axis.title.y=element_text(hjust=yj, size=axis_title_size, |
ret <- ret + theme(axis.title.y=element_text(hjust=yj, size=axis_title_size, |
||||
family=axis_title_family, face=axis_title_face)) |
family=axis_title_family, face=axis_title_face)) |
||||
ret <- ret + theme(axis.title.y.right=element_text(hjust=yj, size=axis_title_size, angle=90, |
ret <- ret + theme(axis.title.y.right=element_text(hjust=yj, size=axis_title_size, angle=90, |
||||
family=axis_title_family, face=axis_title_face)) |
family=axis_title_family, face=axis_title_face)) |
||||
ret <- ret + theme(strip.text=element_text(hjust=0, size=strip_text_size, |
ret <- ret + theme(strip.text=element_text(hjust=0, size=strip_text_size, |
||||
face=strip_text_face, family=strip_text_family)) |
face=strip_text_face, family=strip_text_family)) |
||||
ret <- ret + theme(panel.spacing=grid::unit(2, "lines")) |
ret <- ret + theme(panel.spacing=grid::unit(2, "lines")) |
||||
ret <- ret + theme(plot.title=element_text(hjust=0, size=plot_title_size, |
ret <- ret + theme(plot.title=element_text(hjust=0, size=plot_title_size, |
||||
margin=margin(b=plot_title_margin), |
margin=margin(b=plot_title_margin), |
||||
family=plot_title_family, face=plot_title_face)) |
family=plot_title_family, face=plot_title_face)) |
||||
ret <- ret + theme(plot.subtitle=element_text(hjust=0, size=subtitle_size, |
ret <- ret + theme(plot.subtitle=element_text(hjust=0, size=subtitle_size, |
||||
margin=margin(b=subtitle_margin), |
margin=margin(b=subtitle_margin), |
||||
family=subtitle_family, face=subtitle_face)) |
family=subtitle_family, face=subtitle_face)) |
||||
ret <- ret + theme(plot.caption=element_text(hjust=1, size=caption_size, |
ret <- ret + theme(plot.caption=element_text(hjust=1, size=caption_size, |
||||
margin=margin(t=caption_margin), |
margin=margin(t=caption_margin), |
||||
family=caption_family, face=caption_face)) |
family=caption_family, face=caption_face)) |
||||
ret <- ret + theme(plot.margin=plot_margin) |
ret <- ret + theme(plot.margin=plot_margin) |
||||
|
|
||||
ret |
ret |
||||
|
|
||||
} |
} |
||||
|
|
||||
#' Update matching font defaults for text geoms |
#' Update matching font defaults for text geoms |
||||
#' |
#' |
||||
#' Updates [ggplot2::geom_label] and [ggplot2::geom_text] font defaults |
#' Updates [ggplot2::geom_label] and [ggplot2::geom_text] font defaults |
||||
#' |
#' |
||||
#' @param family,face,size,color font family name, face, size and color |
#' @param family,face,size,color font family name, face, size and color |
||||
#' @export |
#' @export |
||||
update_geom_font_defaults <- function(family="Arial Narrow", face="plain", size=3.5, |
update_geom_font_defaults <- function(family="Arial Narrow", face="plain", size=3.5, |
||||
color = "#2b2b2b") { |
color = "#2b2b2b") { |
||||
update_geom_defaults("text", list(family=family, face=face, size=size, color=color)) |
update_geom_defaults("text", list(family=family, face=face, size=size, color=color)) |
||||
update_geom_defaults("label", list(family=family, face=face, size=size, color=color)) |
update_geom_defaults("label", list(family=family, face=face, size=size, color=color)) |
||||
} |
} |
||||
|
|
||||
#' @rdname ArialNarrow |
#' @rdname ArialNarrow |
||||
#' @md |
#' @md |
||||
#' @title Arial Narrow font name R variable aliases |
#' @title Arial Narrow font name R variable aliases |
||||
#' @description `font_an` == "`Arial Narrow`" |
#' @description `font_an` == "`Arial Narrow`" |
||||
#' @format length 1 character vector |
#' @format length 1 character vector |
||||
#' @export |
#' @export |
||||
font_an <- "Arial Narrow" |
font_an <- "Arial Narrow" |
||||
|
|||||
Loading…
Reference in new issue