From 89b278221272d8961e8f1cf39527f66f962b9f84 Mon Sep 17 00:00:00 2001 From: davidhodge931 Date: Fri, 2 Sep 2022 16:28:38 +1200 Subject: [PATCH] Update doc --- DESCRIPTION | 4 ++-- NEWS.md | 17 +++++++++-------- README.Rmd | 2 +- README.md | 2 +- man/ggblanket-package.Rd | 4 ++-- vignettes/ggblanket.Rmd | 8 ++++---- 6 files changed, 19 insertions(+), 18 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index d86256b20..f8f84cee3 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,10 +1,10 @@ Package: ggblanket -Title: Wrappers to Simplify 'ggplot2' Visualisation +Title: Simplify 'ggplot2' Visualisation Version: 1.4.0 Authors@R: person("David", "Hodge", email = "davidhodge931@gmail.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-3868-7501")) -Description: Simplify visualisation with 'ggplot2' wrapper functions. +Description: Simplify 'ggplot2' visualisation with 'ggblanket' wrapper functions. License: MIT + file LICENSE URL: https://davidhodge931.github.io/ggblanket/, https://github.com/davidhodge931/ggblanket/ diff --git a/NEWS.md b/NEWS.md index cee716fdf..709c5eca1 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,13 +1,14 @@ -# ggblanket 1.3.9000 +# ggblanket 1.4.0 * Breaking: Removed `col_intervals` argument. * Breaking: Removed `*_oob` argument. -* Breaking: In gg_theme, changed `*_style` arguments to `*_face`. -* Breaking: In gg_theme, changed `font` arguments to `family`. +* Breaking: In `gg_theme`, changed `*_style` arguments to `*_face`. +* Breaking: In `gg_theme`, changed `font` arguments to `family`. +* Added `gg_polygon` function. * Added `col_continuous` argument to support colouring by "steps". * Added `col_legend_rev` argument to reverse legends. -* Added `gg_polygon` function. -* Added `facet_space` and `facet_layout` arguments to support proportional facet panels. +* Added `facet_layout` argument for more faceting flexibility. +* Added `facet_space` argument to support proportional facet panels. * Removed `width` default. * Improved default legend look for where continuous gradient. * Improved scales where `y` is NULL and plot is horizontal. @@ -22,10 +23,10 @@ * Added `facet2` aesthetic in to support effortless grid facetting. * Changed default background theme colours. * Fixed bug with `*_limits` and `*_include` not working correctly. -* Added *_sec_axis arguments. -* Changed *_oob default to `scales::oob_keep`. +* Added `*_sec_axis` arguments. +* Changed `*_oob` default to `scales::oob_keep`. * Removed reversal of logical variable order. -* Defaulted col_legend_place to bottom. +* Defaulted `col_legend_place` to `"b"`. # ggblanket 1.2.0 diff --git a/README.Rmd b/README.Rmd index 5d60631ae..36d82aaa0 100644 --- a/README.Rmd +++ b/README.Rmd @@ -32,7 +32,7 @@ knitr::opts_chunk$set( ggblanket is a package of wrapper functions around the fantastic ggplot2 package. -The primary objective is to **simplify visualisation**. +The primary objective is to **simplify ggplot2 visualisation**. Secondary objectives relate to: diff --git a/README.md b/README.md index 73ba7bd0c..cfa5812dc 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ downloads](https://cranlogs.r-pkg.org/badges/last-day/ggblanket?color=lightgrey) ggblanket is a package of wrapper functions around the fantastic ggplot2 package. -The primary objective is to **simplify visualisation**. +The primary objective is to **simplify ggplot2 visualisation**. Secondary objectives relate to: diff --git a/man/ggblanket-package.Rd b/man/ggblanket-package.Rd index cea117c78..0a7cf60f2 100644 --- a/man/ggblanket-package.Rd +++ b/man/ggblanket-package.Rd @@ -4,11 +4,11 @@ \name{ggblanket-package} \alias{ggblanket} \alias{ggblanket-package} -\title{ggblanket: Wrappers to Simplify 'ggplot2' Visualisation} +\title{ggblanket: Simplify 'ggplot2' Visualisation} \description{ \if{html}{\figure{logo.png}{options: style='float: right' alt='logo' width='120'}} -Simplify visualisation with 'ggplot2' wrapper functions. +Simplify 'ggplot2' visualisation with 'ggblanket' wrapper functions. } \seealso{ Useful links: diff --git a/vignettes/ggblanket.Rmd b/vignettes/ggblanket.Rmd index 58ab490fd..5397b8233 100644 --- a/vignettes/ggblanket.Rmd +++ b/vignettes/ggblanket.Rmd @@ -24,7 +24,7 @@ knitr::opts_chunk$set( ggblanket is a package of wrapper functions around the fantastic ggplot2 package. -The primary objective is to **simplify visualisation**. +The primary objective is to **simplify ggplot2 visualisation**. Secondary objectives relate to: @@ -44,9 +44,9 @@ library(palmerpenguins) ## How it works -To simplify visualisation, the ggblanket package provides: +To simplify ggplot2 visualisation, the ggblanket package provides: -* `gg_*` functions to plot a single geom +* `gg_*` wrapper functions to plot a single geom * col and fill aesthetics merged into a single `col` argument * Colours customised via a `pal` argument consistently * A `facet` argument to facet in a "wrap" or "grid" layout @@ -61,7 +61,7 @@ To simplify visualisation, the ggblanket package provides: * A way to easily create your own customised plot functions * Control over `plotly::ggplotly` tooltips with `add_tooltip_text` -### 1. `gg_*` functions to plot a single geom +### 1. `gg_*` wrapper functions to plot a single geom These `gg_*`functions each wrap a ggplot2 `ggplot(aes(...))` function with the applicable ggplot2 `geom_*()` function.