From 968348d86718ae374bbe7aa6515c0321e50d6634 Mon Sep 17 00:00:00 2001 From: gnoblet Date: Sat, 14 May 2022 18:25:20 -0400 Subject: [PATCH] Update documentation for `scale_fill()` and `scale_color()` --- NEWS.md | 2 +- R/internals.R | 2 - R/scale.R | 8 +-- docs/news/index.html | 84 ---------------------- docs/pkgdown.yml | 2 +- docs/reference/scale_color.html | 4 +- docs/reference/scale_fill.html | 4 +- docs/reference/subvec_not_in.html | 88 ----------------------- docs/reference/theme_reach.html | 86 ---------------------- docs/reference/theme_reach_borders.html | 86 ---------------------- docs/reference/theme_reach_flip_hist.html | 86 ---------------------- docs/reference/theme_reach_hist.html | 86 ---------------------- docs/sitemap.xml | 72 ------------------- man/scale_color.Rd | 4 +- man/scale_fill.Rd | 4 +- 15 files changed, 14 insertions(+), 604 deletions(-) delete mode 100644 docs/news/index.html delete mode 100644 docs/reference/subvec_not_in.html delete mode 100644 docs/reference/theme_reach.html delete mode 100644 docs/reference/theme_reach_borders.html delete mode 100644 docs/reference/theme_reach_flip_hist.html delete mode 100644 docs/reference/theme_reach_hist.html delete mode 100644 docs/sitemap.xml diff --git a/NEWS.md b/NEWS.md index e619fc5..07b1895 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,6 +1,6 @@ # visualizeR 0.1.2.9000 -* There was a duplicate `scale_color()` function, which should have been and is now `scale_fill()'` +* There was a duplicate `scale_color()` function, which should have been and is now `scale_fill()` --- diff --git a/R/internals.R b/R/internals.R index 12bbef3..0f145b5 100644 --- a/R/internals.R +++ b/R/internals.R @@ -1,5 +1,3 @@ - - #' @title Abord bad argument #' #' @param arg An argument diff --git a/R/scale.R b/R/scale.R index 9108eb4..ca97358 100644 --- a/R/scale.R +++ b/R/scale.R @@ -1,11 +1,11 @@ #' Color scale constructor for REACH or AGORA colors #' #' @param initiative Either "reach" or "agora -#' @param palette Character name of palette in drsimonj_palettes +#' @param palette Palette name from `pal_reach()` or `pal_agora()` #' @param discrete Boolean indicating whether color aesthetic is discrete or not #' @param reverse Boolean indicating whether the palette should be reversed #' @param ... Additional arguments passed to discrete_scale() or -#' scale_color_gradientn(), used respectively when discrete is TRUE or FALSE +#' scale_color_gradient(), used respectively when discrete is TRUE or FALSE #' @return A color scale for ggplot #' #' @export @@ -41,11 +41,11 @@ scale_color <- function(initiative = "reach", palette = "main", discrete = TRUE #' Fill scale constructor for REACH or AGORA colors #' #' @param initiative Either "reach" or "agora -#' @param palette Character name of palette in drsimonj_palettes +#' @param palette Palette name from `pal_reach()` or `pal_agora()` #' @param discrete Boolean indicating whether color aesthetic is discrete or not #' @param reverse Boolean indicating whether the palette should be reversed #' @param ... Additional arguments passed to discrete_scale() or -#' scale_fill_gradientn(), used respectively when discrete is TRUE or FALSE +#' scale_fill_gradient(), used respectively when discrete is TRUE or FALSE #' @return A fill scale for ggplot #' #' @export diff --git a/docs/news/index.html b/docs/news/index.html deleted file mode 100644 index c88c630..0000000 --- a/docs/news/index.html +++ /dev/null @@ -1,84 +0,0 @@ - -Changelog • visualizeR - Skip to contents - - -
-
-
-

Changelog

- Source: NEWS.md -
- -
-

visualizeR 0.1.2.9000

-
  • There was a duplicate scale_color() function, which should have been and is now scale_fill()' -
    • -
-
-

visualizeR 0.1.1.9000

-
  • Added two horizontal bar functions: hbar(), hbar_percent() (#3)
    • -
  • Added some internals to check for missing columns and bad arguments (#3)
    • -
  • Modified some theme_reach() documentation
    • -
  • Add buffer_bbox() function to produce a buffered bbox, e.g. for use with tmap -
    • -
-
-

visualizeR 0.1.0

-
  • Added a NEWS.md file to track changes to the package
    • -
  • Initiate repo
    • -
-
- - -
-

Developed by Noblet Guillaume.

-
- -
-

Site built with pkgdown 2.0.3.

-
- -
- - - - - - - diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 76506fe..12e64c2 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 2.17.1.1 pkgdown: 2.0.3 pkgdown_sha: ~ articles: {} -last_built: 2022-05-14T14:30Z +last_built: 2022-05-14T22:24Z urls: reference: https://gnoblet.github.io/visualizeR/reference article: https://gnoblet.github.io/visualizeR/articles diff --git a/docs/reference/scale_color.html b/docs/reference/scale_color.html index 8c7538f..5cb2f61 100644 --- a/docs/reference/scale_color.html +++ b/docs/reference/scale_color.html @@ -65,14 +65,14 @@
initiative

Either "reach" or "agora

palette
-

Character name of palette in drsimonj_palettes

+

Palette name from `pal_reach()` or `pal_agora()`

discrete

Boolean indicating whether color aesthetic is discrete or not

reverse

Boolean indicating whether the palette should be reversed

...

Additional arguments passed to discrete_scale() or -scale_color_gradientn(), used respectively when discrete is TRUE or FALSE

+scale_color_gradient(), used respectively when discrete is TRUE or FALSE

Value

diff --git a/docs/reference/scale_fill.html b/docs/reference/scale_fill.html index 99cf2ab..be4f146 100644 --- a/docs/reference/scale_fill.html +++ b/docs/reference/scale_fill.html @@ -65,14 +65,14 @@
initiative

Either "reach" or "agora

palette
-

Character name of palette in drsimonj_palettes

+

Palette name from `pal_reach()` or `pal_agora()`

discrete

Boolean indicating whether color aesthetic is discrete or not

reverse

Boolean indicating whether the palette should be reversed

...

Additional arguments passed to discrete_scale() or -scale_fill_gradientn(), used respectively when discrete is TRUE or FALSE

+scale_fill_gradient(), used respectively when discrete is TRUE or FALSE

Value

diff --git a/docs/reference/subvec_not_in.html b/docs/reference/subvec_not_in.html deleted file mode 100644 index 939c64f..0000000 --- a/docs/reference/subvec_not_in.html +++ /dev/null @@ -1,88 +0,0 @@ - -Subvec not in — subvec_not_in • visualizeR - Skip to contents - - -
-
-
-

Subvec not in

- Source: R/internals.R -
subvec_not_in.Rd
-
- -
-

Subvec not in

-
- -
-

Usage

- 
subvec_not_in(vector, set)
-
- -
-

Arguments

-
vector
-

A vector to subset

-
set
-

A set-vector

-
-
-

Value

-

A subset of vector not in set

-
- -
- - -
-

Developed by Noblet Guillaume.

-
- -
-

Site built with pkgdown 2.0.3.

-
- -
- - - - - - - diff --git a/docs/reference/theme_reach.html b/docs/reference/theme_reach.html deleted file mode 100644 index d6bcdc7..0000000 --- a/docs/reference/theme_reach.html +++ /dev/null @@ -1,86 +0,0 @@ - -Base REACH ggplot2 theme — theme_reach • visualizeR - Skip to contents - - -
-
-
-

Base REACH ggplot2 theme

- Source: R/theme_reach.R -
theme_reach.Rd
-
- -
-

Give some reach colors and fonts to a ggplot. Based on theme_bw()

-
- -
-

Usage

- 
theme_reach(family = "Leelawadee")
-
- -
-

Arguments

-
family
-

The font family. Default to "Leelawadee"

-
-
-

Value

-

The base REACH theme

-
- -
- - -
-

Developed by Noblet Guillaume.

-
- -
-

Site built with pkgdown 2.0.3.

-
- -
- - - - - - - diff --git a/docs/reference/theme_reach_borders.html b/docs/reference/theme_reach_borders.html deleted file mode 100644 index df9af72..0000000 --- a/docs/reference/theme_reach_borders.html +++ /dev/null @@ -1,86 +0,0 @@ - -Some REACH theme for ggplot — theme_reach_borders • visualizeR - Skip to contents - - -
-
-
-

Some REACH theme for ggplot

- Source: R/theme_reach.R -
theme_reach_borders.Rd
-
- -
-

Some REACH theme for ggplot

-
- -
-

Usage

- 
theme_reach_borders(family = "Leelawadee")
-
- -
-

Arguments

-
family
-

The font family. Default to "Leelawadee"

-
-
-

Value

-

A theme to be added to the "+" ggplot grammar

-
- -
- - -
-

Developed by Noblet Guillaume.

-
- -
-

Site built with pkgdown 2.0.3.

-
- -
- - - - - - - diff --git a/docs/reference/theme_reach_flip_hist.html b/docs/reference/theme_reach_flip_hist.html deleted file mode 100644 index a4cd2eb..0000000 --- a/docs/reference/theme_reach_flip_hist.html +++ /dev/null @@ -1,86 +0,0 @@ - -Some reach more minimal theme for a ggplot flipped histogram — theme_reach_flip_hist • visualizeR - Skip to contents - - -
-
-
-

Some reach more minimal theme for a ggplot flipped histogram

- Source: R/theme_reach.R -
theme_reach_flip_hist.Rd
-
- -
-

Give some REACH colors and fonts to a ggplot. Based on theme_bw(). To be used for horizontal bar charts.

-
- -
-

Usage

- 
theme_reach_flip_hist(family = "Leelawadee")
-
- -
-

Arguments

-
family
-

The font family. Default to "Leelawadee"

-
-
-

Value

-

A theme to be added to the "+" ggplot grammar

-
- -
- - -
-

Developed by Noblet Guillaume.

-
- -
-

Site built with pkgdown 2.0.3.

-
- -
- - - - - - - diff --git a/docs/reference/theme_reach_hist.html b/docs/reference/theme_reach_hist.html deleted file mode 100644 index fcb2c72..0000000 --- a/docs/reference/theme_reach_hist.html +++ /dev/null @@ -1,86 +0,0 @@ - -Some reach more minimal theme for a ggplot histogram — theme_reach_hist • visualizeR - Skip to contents - - -
-
-
-

Some reach more minimal theme for a ggplot histogram

- Source: R/theme_reach.R -
theme_reach_hist.Rd
-
- -
-

Give some REACH colors and fonts to a ggplot. Based on theme_bw(). To be used for vertical bar charts.

-
- -
-

Usage

- 
theme_reach_hist(family = "Leelawadee")
-
- -
-

Arguments

-
family
-

The font family. Default to "Leelawadee"

-
-
-

Value

-

A theme to be added to the "+" ggplot grammar

-
- -
- - -
-

Developed by Noblet Guillaume.

-
- -
-

Site built with pkgdown 2.0.3.

-
- -
- - - - - - - diff --git a/docs/sitemap.xml b/docs/sitemap.xml deleted file mode 100644 index 0133eb0..0000000 --- a/docs/sitemap.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - https://gnoblet.github.io/visualizeR/404.html - - - https://gnoblet.github.io/visualizeR/authors.html - - - https://gnoblet.github.io/visualizeR/index.html - - - https://gnoblet.github.io/visualizeR/LICENSE.html - - - https://gnoblet.github.io/visualizeR/news/index.html - - - https://gnoblet.github.io/visualizeR/reference/abort_bad_argument.html - - - https://gnoblet.github.io/visualizeR/reference/buffer_bbox.html - - - https://gnoblet.github.io/visualizeR/reference/cols_agora.html - - - https://gnoblet.github.io/visualizeR/reference/cols_reach.html - - - https://gnoblet.github.io/visualizeR/reference/hbar.html - - - https://gnoblet.github.io/visualizeR/reference/hbar_percent.html - - - https://gnoblet.github.io/visualizeR/reference/if_not_in_stop.html - - - https://gnoblet.github.io/visualizeR/reference/if_vec_not_in_stop.html - - - https://gnoblet.github.io/visualizeR/reference/index.html - - - https://gnoblet.github.io/visualizeR/reference/pal_agora.html - - - https://gnoblet.github.io/visualizeR/reference/pal_reach.html - - - https://gnoblet.github.io/visualizeR/reference/scale_color.html - - - https://gnoblet.github.io/visualizeR/reference/scale_fill.html - - - https://gnoblet.github.io/visualizeR/reference/subvec_not_in.html - - - https://gnoblet.github.io/visualizeR/reference/theme_reach.html - - - https://gnoblet.github.io/visualizeR/reference/theme_reach_borders.html - - - https://gnoblet.github.io/visualizeR/reference/theme_reach_flip_hist.html - - - https://gnoblet.github.io/visualizeR/reference/theme_reach_hist.html - - diff --git a/man/scale_color.Rd b/man/scale_color.Rd index 508f8ae..5139b2a 100644 --- a/man/scale_color.Rd +++ b/man/scale_color.Rd @@ -15,14 +15,14 @@ scale_color( \arguments{ \item{initiative}{Either "reach" or "agora} -\item{palette}{Character name of palette in drsimonj_palettes} +\item{palette}{Palette name from `pal_reach()` or `pal_agora()`} \item{discrete}{Boolean indicating whether color aesthetic is discrete or not} \item{reverse}{Boolean indicating whether the palette should be reversed} \item{...}{Additional arguments passed to discrete_scale() or -scale_color_gradientn(), used respectively when discrete is TRUE or FALSE} +scale_color_gradient(), used respectively when discrete is TRUE or FALSE} } \value{ A color scale for ggplot diff --git a/man/scale_fill.Rd b/man/scale_fill.Rd index 1ba6687..5601e54 100644 --- a/man/scale_fill.Rd +++ b/man/scale_fill.Rd @@ -15,14 +15,14 @@ scale_fill( \arguments{ \item{initiative}{Either "reach" or "agora} -\item{palette}{Character name of palette in drsimonj_palettes} +\item{palette}{Palette name from `pal_reach()` or `pal_agora()`} \item{discrete}{Boolean indicating whether color aesthetic is discrete or not} \item{reverse}{Boolean indicating whether the palette should be reversed} \item{...}{Additional arguments passed to discrete_scale() or -scale_fill_gradientn(), used respectively when discrete is TRUE or FALSE} +scale_fill_gradient(), used respectively when discrete is TRUE or FALSE} } \value{ A fill scale for ggplot