From 0b6a54e4b57b12a71d8348b587413f106c9750e5 Mon Sep 17 00:00:00 2001 From: Christopher Prener Date: Mon, 29 Apr 2019 12:08:06 -0500 Subject: [PATCH] spell check --- R/bi_theme.R | 2 +- README.Rmd | 4 +-- README.md | 4 +-- docs/index.html | 4 +-- docs/reference/bi_theme.html | 2 +- index.Rmd | 4 +-- index.md | 52 ------------------------------------ man/bi_theme.Rd | 2 +- 8 files changed, 11 insertions(+), 63 deletions(-) delete mode 100644 index.md diff --git a/R/bi_theme.R b/R/bi_theme.R index 29d4591..d665df4 100644 --- a/R/bi_theme.R +++ b/R/bi_theme.R @@ -3,7 +3,7 @@ #' @description A theme for creating a simple, clean bivariate map using \code{\link{ggplot2}}. #' #' @param base_family A character string representing the font family to be used in the map. -#' @param base_size A number represeting the base size used in the map. +#' @param base_size A number representing the base size used in the map. #' @param bg_color A character string containing the hex value for the desired color of the map's background. #' @param font_color A character string containing the hex value for the desired color of the map's text. #' @param ... Arguments to pass on to \code{ggplot2}'s \code{theme} function diff --git a/README.Rmd b/README.Rmd index b75ea40..63c59d5 100644 --- a/README.Rmd +++ b/README.Rmd @@ -21,7 +21,7 @@ knitr::opts_chunk$set( [![Coverage status](https://codecov.io/gh/slu-openGIS/biscale/branch/master/graph/badge.svg)](https://codecov.io/github/slu-openGIS/biscale?branch=master) [![CRAN_status_badge](http://www.r-pkg.org/badges/version/biscale)](https://cran.r-project.org/package=biscale) -`biscale` implements a set of functions for bivariate themeatic mapping based on the [tutorial](https://timogrossenbacher.ch/2019/04/bivariate-maps-with-ggplot2-and-sf/) written by Timo Grossenbacher and Angelo Zehr as well as a set of bivariate mapping palettes from Joshua Stevens's [tutorial](http://www.joshuastevens.net/cartography/make-a-bivariate-choropleth-map/). The package currently supports two-by-two and three-by-three bivariate maps: +`biscale` implements a set of functions for bivariate thematic mapping based on the [tutorial](https://timogrossenbacher.ch/2019/04/bivariate-maps-with-ggplot2-and-sf/) written by Timo Grossenbacher and Angelo Zehr as well as a set of bivariate mapping palettes from Joshua Stevens's [tutorial](http://www.joshuastevens.net/cartography/make-a-bivariate-choropleth-map/). The package currently supports two-by-two and three-by-three bivariate maps: ![](man/figures/biscale.001.png) @@ -41,7 +41,7 @@ remotes::install_github("slu-openGIS/biscale") ## Usage ### Quick Overview -Creating bivariate plots in the style described by [Grossenbacher and Zehr](https://timogrossenbacher.ch/2019/04/bivariate-maps-with-ggplot2-and-sf/) requires a number of dependencies in addition to `biscale` - `ggplot2` for plotting, `cowplot` for combining the legend and the main map, and `sf` for working with spaital objects in `R`: +Creating bivariate plots in the style described by [Grossenbacher and Zehr](https://timogrossenbacher.ch/2019/04/bivariate-maps-with-ggplot2-and-sf/) requires a number of dependencies in addition to `biscale` - `ggplot2` for plotting, `cowplot` for combining the legend and the main map, and `sf` for working with spatial objects in `R`: ```r # load dependencies diff --git a/README.md b/README.md index 76d63c0..5eccf9e 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Status](https://ci.appveyor.com/api/projects/status/github/slu-openGIS/biscale?b status](https://codecov.io/gh/slu-openGIS/biscale/branch/master/graph/badge.svg)](https://codecov.io/github/slu-openGIS/biscale?branch=master) [![CRAN\_status\_badge](http://www.r-pkg.org/badges/version/biscale)](https://cran.r-project.org/package=biscale) -`biscale` implements a set of functions for bivariate themeatic mapping +`biscale` implements a set of functions for bivariate thematic mapping based on the [tutorial](https://timogrossenbacher.ch/2019/04/bivariate-maps-with-ggplot2-and-sf/) written by Timo Grossenbacher and Angelo Zehr as well as a set of @@ -63,7 +63,7 @@ Creating bivariate plots in the style described by [Grossenbacher and Zehr](https://timogrossenbacher.ch/2019/04/bivariate-maps-with-ggplot2-and-sf/) requires a number of dependencies in addition to `biscale` - `ggplot2` for plotting, `cowplot` for combining the legend and the main map, and -`sf` for working with spaital objects in `R`: +`sf` for working with spatial objects in `R`: ``` r # load dependencies diff --git a/docs/index.html b/docs/index.html index 96c68c1..3c61bb7 100644 --- a/docs/index.html +++ b/docs/index.html @@ -79,7 +79,7 @@

biscale

-

biscale implements a set of functions for bivariate themeatic mapping based on the tutorial written by Timo Grossenbacher and Angelo Zehr as well as a set of bivariate mapping palettes from Joshua Stevens’s tutorial. The package currently supports two-by-two and three-by-three bivariate maps:

+

biscale implements a set of functions for bivariate thematic mapping based on the tutorial written by Timo Grossenbacher and Angelo Zehr as well as a set of bivariate mapping palettes from Joshua Stevens’s tutorial. The package currently supports two-by-two and three-by-three bivariate maps:

In addition to support for both two-by-two and three-by-three maps, the package also supports four methods for calculating breaks for bivariate maps.

@@ -96,7 +96,7 @@

In addition to instructions for installation, the main Get started article has:

  • a quick overview of bivariate mapping,
    • -
  • a description of the workflrow for creating bivariate maps,
    • +
  • a description of the workflow for creating bivariate maps,
  • a comparison of different approaches to calculating those classes,
  • and a comparison of different color palettes for bivariate mapping.
diff --git a/docs/reference/bi_theme.html b/docs/reference/bi_theme.html index 56cc58c..1685b38 100644 --- a/docs/reference/bi_theme.html +++ b/docs/reference/bi_theme.html @@ -128,7 +128,7 @@

Arg base_size -

A number represeting the base size used in the map.

+

A number representing the base size used in the map.

bg_color diff --git a/index.Rmd b/index.Rmd index cf97ca2..b02cf73 100644 --- a/index.Rmd +++ b/index.Rmd @@ -21,7 +21,7 @@ knitr::opts_chunk$set( [![Coverage status](https://codecov.io/gh/slu-openGIS/biscale/branch/master/graph/badge.svg)](https://codecov.io/github/slu-openGIS/biscale?branch=master) [![CRAN_status_badge](http://www.r-pkg.org/badges/version/biscale)](https://cran.r-project.org/package=biscale) -`biscale` implements a set of functions for bivariate themeatic mapping based on the [tutorial](https://timogrossenbacher.ch/2019/04/bivariate-maps-with-ggplot2-and-sf/) written by Timo Grossenbacher and Angelo Zehr as well as a set of bivariate mapping palettes from Joshua Stevens's [tutorial](http://www.joshuastevens.net/cartography/make-a-bivariate-choropleth-map/). The package currently supports two-by-two and three-by-three bivariate maps: +`biscale` implements a set of functions for bivariate thematic mapping based on the [tutorial](https://timogrossenbacher.ch/2019/04/bivariate-maps-with-ggplot2-and-sf/) written by Timo Grossenbacher and Angelo Zehr as well as a set of bivariate mapping palettes from Joshua Stevens's [tutorial](http://www.joshuastevens.net/cartography/make-a-bivariate-choropleth-map/). The package currently supports two-by-two and three-by-three bivariate maps: ```{r exampleMap, echo=FALSE, out.width = '100%'} knitr::include_graphics("man/figures/biscale.001.png") @@ -43,6 +43,6 @@ Additional details, including some tips for installing `sf`, can be found in the In addition to instructions for installation, the main [Get started](articles/biscale.html) article has: * a quick overview of bivariate mapping, - * a description of the workflrow for creating bivariate maps, + * a description of the workflow for creating bivariate maps, * a comparison of different approaches to calculating those classes, * and a comparison of different color palettes for bivariate mapping. diff --git a/index.md b/index.md deleted file mode 100644 index 28343dc..0000000 --- a/index.md +++ /dev/null @@ -1,52 +0,0 @@ - - - -# biscale - -[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing) -[![Travis-CI Build -Status](https://travis-ci.org/slu-openGIS/biscale.svg?branch=master)](https://travis-ci.org/slu-openGIS/biscale) -[![AppVeyor Build -Status](https://ci.appveyor.com/api/projects/status/github/slu-openGIS/biscale?branch=master&svg=true)](https://ci.appveyor.com/project/chris-prener/biscale) -[![Coverage -status](https://codecov.io/gh/slu-openGIS/biscale/branch/master/graph/badge.svg)](https://codecov.io/github/slu-openGIS/biscale?branch=master) -[![CRAN\_status\_badge](http://www.r-pkg.org/badges/version/biscale)](https://cran.r-project.org/package=biscale) - -`biscale` implements a set of functions for bivariate themeatic mapping -based on the -[tutorial](https://timogrossenbacher.ch/2019/04/bivariate-maps-with-ggplot2-and-sf/) -written by Timo Grossenbacher and Angelo Zehr as well as a set of -bivariate mapping palettes from Joshua Stevens’s -[tutorial](http://www.joshuastevens.net/cartography/make-a-bivariate-choropleth-map/). -The package currently supports two-by-two and three-by-three bivariate -maps: - - - -In addition to support for both two-by-two and three-by-three maps, the -package also supports four methods for calculating breaks for bivariate -maps. - -## Quick Start - -If the `sf` package is already installed, the development version of -`biscale` can be accessed from GitHub with `remotes`: - -``` r -# install.packages("remotes") -remotes::install_github("slu-openGIS/biscale") -``` - -Additional details, including some tips for installing `sf`, can be -found in the [Get started -article](articles/biscale.html#getting-started). - -## Resources - -In addition to instructions for installation, the main [Get -started](articles/biscale.html) article has: - - - a quick overview of bivariate mapping, - - a description of the workflrow for creating bivariate maps, - - a comparison of different approaches to calculating those classes, - - and a comparison of different color palettes for bivariate mapping. diff --git a/man/bi_theme.Rd b/man/bi_theme.Rd index 835bd41..1bb2945 100644 --- a/man/bi_theme.Rd +++ b/man/bi_theme.Rd @@ -10,7 +10,7 @@ bi_theme(base_family = "sans", base_size = 24, bg_color = "#ffffff", \arguments{ \item{base_family}{A character string representing the font family to be used in the map.} -\item{base_size}{A number represeting the base size used in the map.} +\item{base_size}{A number representing the base size used in the map.} \item{bg_color}{A character string containing the hex value for the desired color of the map's background.}