Browse Source

README

tags/0.8.0
boB Rudis 5 years ago
parent
commit
762f19193e
No known key found for this signature in database GPG Key ID: 1D7529BE14E2BBA9
  1. 1
      NAMESPACE
  2. 2
      R/econ-sans.R
  3. BIN
      README_figs/README-unnamed-chunk-6-1.png
  4. BIN
      README_figs/README-unnamed-chunk-7-1.png
  5. 102
      man/theme_ipsum_es.Rd
  6. 98
      man/theme_ipsum_rc.Rd

1
NAMESPACE

@ -43,6 +43,7 @@ export(scale_y_comma)
export(scale_y_percent)
export(theme_ft_rc)
export(theme_ipsum)
export(theme_ipsum_es)
export(theme_ipsum_ps)
export(theme_ipsum_pub)
export(theme_ipsum_rc)

2
R/econ-sans.R

@ -60,7 +60,7 @@
#' theme_ipsum_es(grid="Y") +
#' theme(axis.text.y=element_blank())
#' }
theme_ipsum_rc <- function(
theme_ipsum_es <- function(
base_family="EconSansCndReg", base_size = 11.5,
plot_title_family="EconSansCndBol", plot_title_size = 18,
plot_title_face="bold", plot_title_margin = 10,

BIN
README_figs/README-unnamed-chunk-6-1.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 212 KiB

After

Width:  |  Height:  |  Size: 213 KiB

BIN
README_figs/README-unnamed-chunk-7-1.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 212 KiB

After

Width:  |  Height:  |  Size: 213 KiB

102
man/theme_ipsum_es.Rd

@ -0,0 +1,102 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/econ-sans.R
\name{theme_ipsum_es}
\alias{theme_ipsum_es}
\title{A precise & pristine \link{ggplot2} theme with opinionated defaults and an emphasis on typoghraphy}
\usage{
theme_ipsum_es(base_family = "EconSansCndReg", base_size = 11.5,
plot_title_family = "EconSansCndBol", plot_title_size = 18,
plot_title_face = "bold", plot_title_margin = 10,
subtitle_family = if (.Platform$OS.type == "windows") "EconSansCndLig"
else "EconSansCndLigt", subtitle_size = 13, subtitle_face = "plain",
subtitle_margin = 15, strip_text_family = base_family,
strip_text_size = 12, strip_text_face = "plain",
caption_family = if (.Platform$OS.type == "windows") "EconSansCndLig"
else "EconSansCndLig", caption_size = 9, caption_face = "plain",
caption_margin = 10, axis_text_size = base_size,
axis_title_family = base_family, axis_title_size = 9,
axis_title_face = "plain", axis_title_just = "rt",
plot_margin = margin(30, 30, 30, 30), panel_spacing = grid::unit(2,
"lines"), grid_col = "#cccccc", grid = TRUE, axis_col = "#cccccc",
axis = FALSE, ticks = FALSE)
}
\arguments{
\item{base_family, base_size}{base font family and size}
\item{plot_title_family, plot_title_face, plot_title_size, plot_title_margin}{plot tilte family, face, size and margin}
\item{subtitle_family, subtitle_face, subtitle_size}{plot subtitle family, face and size}
\item{subtitle_margin}{plot subtitle margin bottom (single numeric value)}
\item{strip_text_family, strip_text_face, strip_text_size}{facet label font family, face and size}
\item{caption_family, caption_face, caption_size, caption_margin}{plot caption family, face, size and margin}
\item{axis_text_size}{font size of axis text}
\item{axis_title_family, axis_title_face, axis_title_size}{axis title font family, face and size}
\item{axis_title_just}{axis title font justificationk one of \code{[blmcrt]}}
\item{plot_margin}{plot margin (specify with \link[ggplot2:margin]{ggplot2::margin})}
\item{panel_spacing}{panel spacing (use \code{unit()})}
\item{grid_col}{grid color}
\item{grid}{panel grid (\code{TRUE}, \code{FALSE}, or a combination of \code{X}, \code{x}, \code{Y}, \code{y})}
\item{axis_col}{axis color}
\item{axis}{add x or y axes? \code{TRUE}, \code{FALSE}, "\code{xy}"}
\item{ticks}{ticks if \code{TRUE} add ticks}
}
\description{
You should \url{import_econ_sans} first and also install the fonts on your
system before trying to use this theme.
}
\details{
There is an option \code{hrbrthemes.loadfonts} which -- if set to \code{TRUE} -- will
call \code{extrafont::loadfonts()} to register non-core fonts with R PDF & PostScript
devices. If you are running under Windows, the package calls the same function
to register non-core fonts with the Windows graphics device.
}
\section{Why Econ Sans Condensed?}{
It's free, has tolerable kerning pairs and multiple weights. It's also different
than Arial Narrow and the fonts most folks use in ggplot2 charts.
}
\examples{
\dontrun{
library(ggplot2)
library(dplyr)
# seminal scatterplot
ggplot(mtcars, aes(mpg, wt)) +
geom_point() +
labs(x="Fuel effiiency (mpg)", y="Weight (tons)",
title="Seminal ggplot2 scatterplot example",
subtitle="A plot that is only useful for demonstration purposes",
caption="Brought to you by the letter 'g'") +
theme_ipsum_es()
# seminal bar chart
# note: may need to make this font_es on Windows
update_geom_font_defaults(family=font_es_light)
count(mpg, class) \%>\%
ggplot(aes(class, n)) +
geom_col() +
geom_text(aes(label=n), nudge_y=3) +
labs(x="Fuel effiiency (mpg)", y="Weight (tons)",
title="Seminal ggplot2 bar chart example",
subtitle="A plot that is only useful for demonstration purposes",
caption="Brought to you by the letter 'g'") +
theme_ipsum_es(grid="Y") +
theme(axis.text.y=element_blank())
}
}

98
man/theme_ipsum_rc.Rd

@ -1,28 +1,11 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/econ-sans.R, R/ft.R, R/modern.r,
% R/roboto-condensed.r
\name{theme_ipsum_rc}
\alias{theme_ipsum_rc}
% Please edit documentation in R/ft.R, R/modern.r, R/roboto-condensed.r
\name{theme_ft_rc}
\alias{theme_ft_rc}
\alias{theme_modern_rc}
\alias{theme_ipsum_rc}
\title{A precise & pristine \link{ggplot2} theme with opinionated defaults and an emphasis on typoghraphy}
\usage{
theme_ipsum_rc(base_family = "Roboto Condensed", base_size = 11.5,
plot_title_family = base_family, plot_title_size = 18,
plot_title_face = "bold", plot_title_margin = 10,
subtitle_family = if (.Platform$OS.type == "windows")
"Roboto Condensed" else "Roboto Condensed Light", subtitle_size = 13,
subtitle_face = "plain", subtitle_margin = 15,
strip_text_family = base_family, strip_text_size = 12,
strip_text_face = "plain", caption_family = if (.Platform$OS.type ==
"windows") "Roboto Condensed" else "Roboto Condensed Light",
caption_size = 9, caption_face = "plain", caption_margin = 10,
axis_text_size = base_size, axis_title_family = base_family,
axis_title_size = 9, axis_title_face = "plain",
axis_title_just = "rt", plot_margin = margin(30, 30, 30, 30),
panel_spacing = grid::unit(2, "lines"), grid_col = "#cccccc",
grid = TRUE, axis_col = "#cccccc", axis = FALSE, ticks = FALSE)
theme_ft_rc(base_family = "Roboto Condensed", base_size = 11.5,
plot_title_family = base_family, plot_title_size = 18,
plot_title_face = "bold", plot_title_margin = 10,
@ -90,54 +73,19 @@ theme_ipsum_rc(base_family = "Roboto Condensed", base_size = 11.5,
\item{plot_margin}{plot margin (specify with \link[ggplot2:margin]{ggplot2::margin})}
\item{panel_spacing}{panel spacing (use \code{unit()})}
\item{grid_col}{grid color}
\item{grid}{panel grid (\code{TRUE}, \code{FALSE}, or a combination of \code{X}, \code{x}, \code{Y}, \code{y})}
\item{axis_col}{axis color}
\item{axis}{add x or y axes? \code{TRUE}, \code{FALSE}, "\code{xy}"}
\item{ticks}{ticks if \code{TRUE} add ticks}
\item{base_family, base_size}{base font family and size}
\item{plot_title_family, plot_title_face, plot_title_size, plot_title_margin}{plot tilte family, face, size and margin}
\item{subtitle_family, subtitle_face, subtitle_size}{plot subtitle family, face and size}
\item{subtitle_margin}{plot subtitle margin bottom (single numeric value)}
\item{strip_text_family, strip_text_face, strip_text_size}{facet label font family, face and size}
\item{caption_family, caption_face, caption_size, caption_margin}{plot caption family, face, size and margin}
\item{axis_title_family, axis_title_face, axis_title_size}{axis title font family, face and size}
\item{axis_title_just}{axis title font justificationk one of \code{[blmcrt]}}
\item{axis_text_size}{font size of axis text}
\item{plot_margin}{plot margin (specify with \link[ggplot2:margin]{ggplot2::margin})}
\item{panel_spacing}{panel spacing (use \code{unit()})}
\item{grid_col}{grid color}
\item{grid}{panel grid (\code{TRUE}, \code{FALSE}, or a combination of \code{X}, \code{x}, \code{Y}, \code{y})}
\item{axis_col}{axis color}
\item{axis}{add x or y axes? \code{TRUE}, \code{FALSE}, "\code{xy}"}
\item{ticks}{ticks if \code{TRUE} add ticks}
}
\description{
You should \url{import_econ_sans} first and also install the fonts on your
system before trying to use this theme.
You should \url{import_roboto_condensed} first and also install the fonts on your
system before trying to use this theme.
}
@ -146,18 +94,7 @@ There is an option \code{hrbrthemes.loadfonts} which -- if set to \code{TRUE} --
call \code{extrafont::loadfonts()} to register non-core fonts with R PDF & PostScript
devices. If you are running under Windows, the package calls the same function
to register non-core fonts with the Windows graphics device.
There is an option \code{hrbrthemes.loadfonts} which -- if set to \code{TRUE} -- will
call \code{extrafont::loadfonts()} to register non-core fonts with R PDF & PostScript
devices. If you are running under Windows, the package calls the same function
to register non-core fonts with the Windows graphics device.
}
\section{Why Econ Sans Condensed?}{
It's free, has tolerable kerning pairs and multiple weights. It's also different
than Arial Narrow and the fonts most folks use in ggplot2 charts.
}
\section{Why Roboto Condensed?}{
It's free, has tolerable kerning pairs and multiple weights. It's also different
@ -176,35 +113,6 @@ ggplot(mtcars, aes(mpg, wt)) +
title="Seminal ggplot2 scatterplot example",
subtitle="A plot that is only useful for demonstration purposes",
caption="Brought to you by the letter 'g'") +
theme_ipsum_es()
# seminal bar chart
# note: may need to make this font_es on Windows
update_geom_font_defaults(family=font_es_light)
count(mpg, class) \%>\%
ggplot(aes(class, n)) +
geom_col() +
geom_text(aes(label=n), nudge_y=3) +
labs(x="Fuel effiiency (mpg)", y="Weight (tons)",
title="Seminal ggplot2 bar chart example",
subtitle="A plot that is only useful for demonstration purposes",
caption="Brought to you by the letter 'g'") +
theme_ipsum_es(grid="Y") +
theme(axis.text.y=element_blank())
}
\dontrun{
library(ggplot2)
library(dplyr)
# seminal scatterplot
ggplot(mtcars, aes(mpg, wt)) +
geom_point() +
labs(x="Fuel effiiency (mpg)", y="Weight (tons)",
title="Seminal ggplot2 scatterplot example",
subtitle="A plot that is only useful for demonstration purposes",
caption="Brought to you by the letter 'g'") +
theme_ipsum_rc()
# seminal bar chart

Loading…
Cancel
Save