Browse Source

doc tweaks

tags/0.8.0
boB Rudis 4 years ago
parent
commit
a8134f6a58
No known key found for this signature in database GPG Key ID: 1D7529BE14E2BBA9
  1. 2
      .Rbuildignore
  2. 2
      .gitignore
  3. 2
      DESCRIPTION
  4. 2
      R/color.r
  5. 2
      R/econ-sans.R
  6. 2
      R/ft.R
  7. 2
      R/plexsans.R
  8. 2
      R/public-sans.R
  9. 2
      R/roboto-condensed.r
  10. 2
      R/theme-ipsum.r
  11. 2
      R/tinyhand.R
  12. 2
      R/titillium-web.R
  13. 2
      man/scale_ft.Rd
  14. 2
      man/scale_ipsum.Rd
  15. 2
      man/theme_ipsum.Rd
  16. 2
      man/theme_ipsum_es.Rd
  17. 2
      man/theme_ipsum_ps.Rd
  18. 2
      man/theme_ipsum_pub.Rd
  19. 2
      man/theme_ipsum_rc.Rd
  20. 2
      man/theme_ipsum_tw.Rd
  21. 2
      man/theme_tinyhand.Rd

2
.Rbuildignore

@ -13,3 +13,5 @@
^cran-comments\.md$
^docs$
^build$
^doc$
^Meta$

2
.gitignore

@ -8,3 +8,5 @@ src/*.dll
notes.txt
inst/doc
.DS_Store
doc
Meta

2
DESCRIPTION

@ -59,5 +59,3 @@ Imports:
gdtools
RoxygenNote: 7.0.2
VignetteBuilder: knitr
Remotes:
tidyverse/ggplot2

2
R/color.r

@ -10,7 +10,7 @@ ipsum_pal <- function() { manual_pal(ipsum_palette) }
#' Discrete color & fill scales based on the ipsum palette
#'
#' See [ipsum_pal]().
#' See [ipsum_pal()].
#'
#' @md
#' @inheritDotParams ggplot2::discrete_scale -expand -position

2
R/econ-sans.R

@ -1,6 +1,6 @@
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typoghraphy
#'
#' You should [import_econ_sans]() first and also install the fonts on your
#' You should [import_econ_sans()] first and also install the fonts on your
#' system before trying to use this theme.
#'
#' There is an option `hrbrthemes.loadfonts` which -- if set to `TRUE` -- will

2
R/ft.R

@ -202,7 +202,7 @@ ft_pal <- function() {
#' Discrete color & fill scales based on the FT palette
#'
#' See [ft_pal]().
#' See [ft_pal()].
#'
#' @md
#' @inheritDotParams ggplot2::discrete_scale -expand -position

2
R/plexsans.R

@ -1,6 +1,6 @@
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typoghraphy
#'
#' You should [import_plex_sans]() first and also install the fonts on your
#' You should [import_plex_sans()] first and also install the fonts on your
#' system before trying to use this theme.
#'
#' There is an option `hrbrthemes.loadfonts` which -- if set to `TRUE` -- will

2
R/public-sans.R

@ -1,6 +1,6 @@
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typoghraphy
#'
#' You should [import_public_sans]() first and also install the fonts on your
#' You should [import_public_sans()] first and also install the fonts on your
#' system before trying to use this theme.
#'
#' There is an option `hrbrthemes.loadfonts` which -- if set to `TRUE` -- will

2
R/roboto-condensed.r

@ -1,6 +1,6 @@
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typoghraphy
#'
#' You should [import_roboto_condensed]() first and also install the fonts on your
#' You should [import_roboto_condensed()] first and also install the fonts on your
#' system before trying to use this theme.
#'
#' There is an option `hrbrthemes.loadfonts` which -- if set to `TRUE` -- will

2
R/theme-ipsum.r

@ -34,7 +34,7 @@
#' @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 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 panel grid (`TRUE`, `FALSE`, or a combination of `X`, `x`, `Y`, `y`)
#' @param axis_text_size font size of axis text

2
R/tinyhand.R

@ -9,7 +9,7 @@ font_th <- "BFTinyHand-Regular"
#' Something you should never use.
#'
#' You should [import_tinyhand]() first and also install the fonts on your
#' You should [import_tinyhand()] first and also install the fonts on your
#' system before trying to use this theme.
#'
#' There is an option `hrbrthemes.loadfonts` which -- if set to `TRUE` -- will

2
R/titillium-web.R

@ -1,6 +1,6 @@
#' A precise & pristine [ggplot2] theme with opinionated defaults and an emphasis on typoghraphy
#'
#' You should [import_titillium_web]() first and also install the fonts on your
#' You should [import_titillium_web()] first and also install the fonts on your
#' system before trying to use this theme.
#'
#' There is an option `hrbrthemes.loadfonts` which -- if set to `TRUE` -- will

2
man/scale_ft.Rd

@ -60,5 +60,5 @@ The default, \code{TRUE}, uses the levels that appear in the data;
}}
}
\description{
See \url{ft_pal}.
See \code{\link[=ft_pal]{ft_pal()}}.
}

2
man/scale_ipsum.Rd

@ -60,5 +60,5 @@ The default, \code{TRUE}, uses the levels that appear in the data;
}}
}
\description{
See \url{ipsum_pal}.
See \code{\link[=ipsum_pal]{ipsum_pal()}}.
}

2
man/theme_ipsum.Rd

@ -54,7 +54,7 @@ theme_ipsum(
\item{axis_title_just}{axis title font justification, one of \verb{[blmcrt]}}
\item{plot_margin}{plot margin (specify with \code{\link[ggplot2:margin]{ggplot2::margin()}})}
\item{plot_margin}{plot margin (specify with \code{ggplot2::margin()})}
\item{grid_col, axis_col}{grid & axis colors; both default to \verb{#cccccc}}

2
man/theme_ipsum_es.Rd

@ -72,7 +72,7 @@ theme_ipsum_es(
\item{ticks}{ticks if \code{TRUE} add ticks}
}
\description{
You should \url{import_econ_sans} first and also install the fonts on your
You should \code{\link[=import_econ_sans]{import_econ_sans()}} first and also install the fonts on your
system before trying to use this theme.
}
\details{

2
man/theme_ipsum_ps.Rd

@ -69,7 +69,7 @@ theme_ipsum_ps(
\item{ticks}{ticks if \code{TRUE} add ticks}
}
\description{
You should \url{import_plex_sans} first and also install the fonts on your
You should \code{\link[=import_plex_sans]{import_plex_sans()}} first and also install the fonts on your
system before trying to use this theme.
}
\details{

2
man/theme_ipsum_pub.Rd

@ -70,7 +70,7 @@ theme_ipsum_pub(
\item{ticks}{ticks if \code{TRUE} add ticks}
}
\description{
You should \url{import_public_sans} first and also install the fonts on your
You should \code{\link[=import_public_sans]{import_public_sans()}} first and also install the fonts on your
system before trying to use this theme.
}
\details{

2
man/theme_ipsum_rc.Rd

@ -136,7 +136,7 @@ theme_ipsum_rc(
\item{axis_col}{axis color}
}
\description{
You should \url{import_roboto_condensed} first and also install the fonts on your
You should \code{\link[=import_roboto_condensed]{import_roboto_condensed()}} first and also install the fonts on your
system before trying to use this theme.
}
\details{

2
man/theme_ipsum_tw.Rd

@ -70,7 +70,7 @@ theme_ipsum_tw(
\item{ticks}{ticks if \code{TRUE} add ticks}
}
\description{
You should \url{import_titillium_web} first and also install the fonts on your
You should \code{\link[=import_titillium_web]{import_titillium_web()}} first and also install the fonts on your
system before trying to use this theme.
}
\details{

2
man/theme_tinyhand.Rd

@ -67,7 +67,7 @@ theme_tinyhand(
\item{ticks}{ticks if \code{TRUE} add ticks}
}
\description{
You should \url{import_tinyhand} first and also install the fonts on your
You should \code{\link[=import_tinyhand]{import_tinyhand()}} first and also install the fonts on your
system before trying to use this theme.
}
\details{

Loading…
Cancel
Save