Skip to content
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.

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

Spellcheck, fix docs for R CMD check, rebuild pkgdown #63

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,5 @@ Imports:
tools,
magrittr,
gdtools
RoxygenNote: 7.1.1
RoxygenNote: 7.1.2
VignetteBuilder: knitr
6 changes: 3 additions & 3 deletions R/econ-sans.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typoghraphy
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typography
#'
#' You should [import_econ_sans()] first and also install the fonts on your
#' system before trying to use this theme.
Expand All @@ -15,13 +15,13 @@
#'
#' @md
#' @param base_family,base_size base font family and size
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot tilte family, face, size and margin
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot title family, face, size and margin
#' @param subtitle_family,subtitle_face,subtitle_size plot subtitle family, face and size
#' @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 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_just axis title font justificationk one of `[blmcrt]`
#' @param axis_title_just axis title font justification; one of `[blmcrt]`
#' @param axis_text_size font size of axis text
#' @param plot_margin plot margin (specify with [ggplot2::margin])
#' @param panel_spacing panel spacing (use `unit()`)
Expand Down
4 changes: 2 additions & 2 deletions R/flush-ticks.R
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
#' Makes axis text labels flush on the ends
#'
#' A covenience function intended for basic, fixed-scale plots only (i.e. does not handle
#' A convenience function intended for basic, fixed-scale plots only (i.e. does not handle
#' free scales in facets).\cr
#' \cr
#' You need to pass in a ggplot2 object to this function. It can't be `+`'d in a chain
#' of geoms, coords, scales, themes, etc. It also builds the plot (but does not display
#' it) so if the plt takes a while (i.e. has lots of data or transforms) this will also
#' it) so if the plot takes a while (i.e. has lots of data or transforms) this will also
#' take a while.
#'
#' @md
Expand Down
6 changes: 3 additions & 3 deletions R/goldmansans.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typoghraphy
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typography
#'
#' You should [import_goldman_sans()] first and also install the fonts on your
#' system before trying to use this theme.
Expand All @@ -14,13 +14,13 @@
#'
#' @md
#' @param base_family,base_size base font family and size
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot tilte family, face, size and margin
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot title family, face, size and margin
#' @param subtitle_family,subtitle_face,subtitle_size plot subtitle family, face and size
#' @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 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_just axis title font justificationk one of `[blmcrt]`
#' @param axis_title_just axis title font justification; one of `[blmcrt]`
#' @param axis_text_size font size of axis text
#' @param plot_margin plot margin (specify with [ggplot2::margin])
#' @param grid_col grid color
Expand Down
8 changes: 4 additions & 4 deletions R/inter.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typoghraphy
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typography
#'
#' You should [import_inter()] first and also install the fonts on your
#' system before trying to use this theme.
Expand All @@ -14,14 +14,14 @@
#'
#' @md
#' @param base_family,base_size base font family and size
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot tilte family, face, size and margin
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot title family, face, size and margin
#' @param subtitle_family,subtitle_face,subtitle_size plot subtitle family, face and size
#' @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 caption_family,caption_face,caption_size,caption_margin plot caption family, face, size and margin
#' @param axis_text_family,axis_text_face,axis_text_size axis text 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 justificationk one of `[blmcrt]`
#' @param axis_text_size font size of axis text
#' @param axis_title_just axis title font justification; one of `[blmcrt]`
#' @param plot_margin plot margin (specify with [ggplot2::margin])
#' @param grid_col grid color
#' @param grid panel grid (`TRUE`, `FALSE`, or a combination of `X`, `x`, `Y`, `y`)
Expand Down
2 changes: 1 addition & 1 deletion R/ipsum.r
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
#' @param toc,toc_depth TOC params
#' @param extra_dependencies,... Additional function arguments to pass to the
#' base R Markdown HTML output formatter
#' @param smart Deprecated
#' @export
ipsum <- function(number_sections = FALSE,
fig_width = 7,
Expand Down Expand Up @@ -90,7 +91,6 @@ ipsum <- function(number_sections = FALSE,
clean_supporting = self_contained,
pre_processor = pre_processor,
base_format = rmarkdown::html_document_base(
smart = smart,
Copy link
Author

Choose a reason for hiding this comment

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

This is the one code change. Since this is getting passed through to ... and ignored, it should not affect behavior.

theme = theme,
self_contained = self_contained,
lib_dir = lib_dir,
Expand Down
6 changes: 3 additions & 3 deletions R/plexsans.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typoghraphy
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typography
#'
#' You should [import_plex_sans()] first and also install the fonts on your
#' system before trying to use this theme.
Expand All @@ -15,13 +15,13 @@
#'
#' @md
#' @param base_family,base_size base font family and size
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot tilte family, face, size and margin
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot title family, face, size and margin
#' @param subtitle_family,subtitle_face,subtitle_size plot subtitle family, face and size
#' @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 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_just axis title font justificationk one of `[blmcrt]`
#' @param axis_title_just axis title font justification; one of `[blmcrt]`
#' @param axis_text_size font size of axis text
#' @param plot_margin plot margin (specify with [ggplot2::margin])
#' @param grid_col grid color
Expand Down
6 changes: 3 additions & 3 deletions R/public-sans.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typoghraphy
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typography
#'
#' You should [import_public_sans()] first and also install the fonts on your
#' system before trying to use this theme.
Expand All @@ -15,13 +15,13 @@
#'
#' @md
#' @param base_family,base_size base font family and size
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot tilte family, face, size and margin
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot title family, face, size and margin
#' @param subtitle_family,subtitle_face,subtitle_size plot subtitle family, face and size
#' @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 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_just axis title font justificationk one of `[blmcrt]`
#' @param axis_title_just axis title font justification; one of `[blmcrt]`
#' @param axis_text_size font size of axis text
#' @param plot_margin plot margin (specify with [ggplot2::margin])
#' @param grid_col grid color
Expand Down
6 changes: 3 additions & 3 deletions R/roboto-condensed.r
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typoghraphy
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typography
#'
#' You should [import_roboto_condensed()] first and also install the fonts on your
#' system before trying to use this theme.
Expand All @@ -15,13 +15,13 @@
#'
#' @md
#' @param base_family,base_size base font family and size
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot tilte family, face, size and margin
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot title family, face, size and margin
#' @param subtitle_family,subtitle_face,subtitle_size plot subtitle family, face and size
#' @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 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_just axis title font justificationk one of `[blmcrt]`
#' @param axis_title_just axis title font justification; one of `[blmcrt]`
#' @param axis_text_size font size of axis text
#' @param plot_margin plot margin (specify with [ggplot2::margin])
#' @param panel_spacing panel spacing (use `unit()`)
Expand Down
4 changes: 2 additions & 2 deletions R/scales.r
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ is.waive <- function (x) { inherits(x, "waiver") }
is.sec_axis <- function (x) { inherits(x, "AxisSecondary") }
is.formula <- function (x) { inherits(x, "formula") }

#' X & Y scales with opinionated pre-sets for percent & comma label formats
#' X & Y scales with opinionated presets for percent & comma label formats
#'
#' The `_comma` ones set comma format for axis text and `expand=c(0,0)` (you need to set limits).
#'
#' The `_percent` ones set precent format for axis text and `expand=c(0,0)` (you need to set limits).
#' The `_percent` ones set percent format for axis text and `expand=c(0,0)` (you need to set limits).
#'
#' @md
#' @param name The name of the scale. Used as axis or legend title. If
Expand Down
4 changes: 2 additions & 2 deletions R/tinyhand.R
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ font_th <- "BFTinyHand-Regular"
#'
#' @md
#' @param base_family,base_size base font family and size
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot tilte family, face, size and margin
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot title family, face, size and margin
#' @param subtitle_family,subtitle_face,subtitle_size plot subtitle family, face and size
#' @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 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_just axis title font justificationk one of `[blmcrt]`
#' @param axis_title_just axis title font justification; one of `[blmcrt]`
#' @param axis_text_size font size of axis text
#' @param plot_margin plot margin (specify with [ggplot2::margin])
#' @param grid_col grid color
Expand Down
6 changes: 3 additions & 3 deletions R/titillium-web.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typoghraphy
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typography
#'
#' You should [import_titillium_web()] first and also install the fonts on your
#' system before trying to use this theme.
Expand All @@ -15,13 +15,13 @@
#'
#' @md
#' @param base_family,base_size base font family and size
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot tilte family, face, size and margin
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot title family, face, size and margin
#' @param subtitle_family,subtitle_face,subtitle_size plot subtitle family, face and size
#' @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 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_just axis title font justificationk one of `[blmcrt]`
#' @param axis_title_just axis title font justification; one of `[blmcrt]`
#' @param axis_text_size font size of axis text
#' @param plot_margin plot margin (specify with [ggplot2::margin])
#' @param grid_col grid color
Expand Down
4 changes: 2 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Themes:
- `theme_ipsum_rc`: Roboto Condensed
- `theme_ipsum_ps`: IBM Plex Sans font
- `theme_ipsum_pub`: Public Sans
- `theme_ipsum_tw`: Titilium Web
- `theme_ipsum_tw`: Titillium Web
- `theme_modern_rc`: Roboto Condensed dark theme
- `theme_ft_rc`: Dark theme based on FT's dark theme (Roboto Condensed)

Expand Down Expand Up @@ -273,4 +273,4 @@ cloc::cloc_pkg_md()

### Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Themes:
- `theme_ipsum_rc`: Roboto Condensed
- `theme_ipsum_ps`: IBM Plex Sans font
- `theme_ipsum_pub`: Public Sans
- `theme_ipsum_tw`: Titilium Web
- `theme_ipsum_tw`: Titillium Web
- `theme_modern_rc`: Roboto Condensed dark theme
- `theme_ft_rc`: Dark theme based on FT’s dark theme (Roboto
Condensed)
Expand Down
1 change: 1 addition & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
url: https://cinc.rud.is/web/packages/hrbrthemes
115 changes: 115 additions & 0 deletions docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading