diff --git a/.Rbuildignore b/.Rbuildignore index fa43e2c..adb541c 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -13,3 +13,4 @@ ^index\.Rmd$ ^index\.md$ ^LICENSE$ +^CRAN-SUBMISSION$ diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION new file mode 100644 index 0000000..da53493 --- /dev/null +++ b/CRAN-SUBMISSION @@ -0,0 +1,3 @@ +Version: 1.0.0 +Date: 2022-05-26 18:11:26 UTC +SHA: 96539cf90837330b7132703c96dd285b84f90f9b diff --git a/DESCRIPTION b/DESCRIPTION index 01150e5..06c9b4b 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: biscale Type: Package Title: Tools and Palettes for Bivariate Thematic Mapping -Version: 1.0.0.9000 +Version: 1.0.0 Authors@R: c( person("Christopher", "Prener", , "chris.prener@gmail.com", c("aut", "cre"), comment = c(ORCID = "0000-0002-4310-9888")), diff --git a/NEWS.md b/NEWS.md index ea0a659..35d99be 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# biscale 1.0.0.9999 +# biscale 1.0.0 * New features * `bi_class()` now accepts factors for one or both of the `x` and `y` variables, allowing more flexibility for how breaks are calculated. If you want finer grained control over your categories, calculate them ahead of time and then pass the factors on to `bi_class()`. diff --git a/R/bi_pal.R b/R/bi_pal.R index 85c1ba0..8779381 100755 --- a/R/bi_pal.R +++ b/R/bi_pal.R @@ -5,9 +5,11 @@ #' #' @details The \code{"Brown"}, \code{"DkBlue"}, \code{"DkCyan"}, and \code{"GrPink"} #' palettes were made by -#' \href{http://www.joshuastevens.net/cartography/make-a-bivariate-choropleth-map/}{Joshua Stevens}. +#' \href{https://www.joshuastevens.net/cartography/make-a-bivariate-choropleth-map/}{Joshua Stevens}. #' The \code{"DkViolet"} palette was made by #' \href{https://timogrossenbacher.ch/2019/04/bivariate-maps-with-ggplot2-and-sf/}{Timo Grossenbacher and Angelo Zehr}. +#' Many of the new palettes were inspired by Branson Fox's earlier work to expand +#' \code{biscale}. #' #' @usage bi_pal(pal, dim = 3, preview = TRUE, flip_axes = FALSE, rotate_pal = FALSE) #' diff --git a/README.Rmd b/README.Rmd index d2c62a6..16ce658 100644 --- a/README.Rmd +++ b/README.Rmd @@ -28,7 +28,7 @@ knitr::opts_chunk$set( In addition to support for two-by-two, three-by-three, and four-by-four maps, the package also supports a range of methods for calculating breaks for bivariate maps. -## What's New in v1.0.0.9000? +## What's New in v1.0.0? ### New Features * `bi_class()` now accepts factors for one or both of the `x` and `y` variables, allowing more flexibility for how breaks are calculated. If you want finer grained control over your categories, calculate them ahead of time and then pass the factors on to `bi_class()`. * `bi_pal()`, `bi_legend()`, `bi_scale_fill()`, and `bi_scale_color()` functions all support four-by-four bivariate maps when `dim = 4`. Note that the original five palettes do not support four-by-four mapping, but very close approximations (e.g. `DkBlue2` instead of `DkBlue`) are now provided in their place. The legacy palettes are all still included in the package. diff --git a/README.md b/README.md index d1f8519..9b6ad28 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ In addition to support for two-by-two, three-by-three, and four-by-four maps, the package also supports a range of methods for calculating breaks for bivariate maps. -## What’s New in v1.0.0.9000? +## What’s New in v1.0.0? ### New Features diff --git a/index.md b/index.md index cea8d21..4176090 100644 --- a/index.md +++ b/index.md @@ -10,7 +10,7 @@ `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, including Joshua Stevens' [classic color schemes](http://www.joshuastevens.net/cartography/make-a-bivariate-choropleth-map/). In addition to support for two-by-two, three-by-three, and four-by-four maps, the package also supports a range of methods for calculating breaks for bivariate maps. -## What's New in v1.0.0.9000? +## What's New in v1.0.0? ### New Features * `bi_class()` now accepts factors for one or both of the `x` and `y` variables, allowing more flexibility for how breaks are calculated. If you want finer grained control over your categories, calculate them ahead of time and then pass the factors on to `bi_class()`. * `bi_pal()`, `bi_legend()`, `bi_scale_fill()`, and `bi_scale_color()` functions all support four-by-four bivariate maps when `dim = 4`. Note that the original five palettes do not support four-by-four mapping, but very close approximations (e.g. `DkBlue2` instead of `DkBlue`) are now provided in their place. The legacy palettes are all still included in the package. diff --git a/man/bi_class.Rd b/man/bi_class.Rd index deb22b4..d965dcb 100644 --- a/man/bi_class.Rd +++ b/man/bi_class.Rd @@ -16,9 +16,13 @@ classes) or factor} classes) or factor} \item{style}{A string identifying the style used to calculate breaks. Currently -supported styles are \code{"quantile"} (default), \code{"equal"}, \code{"fisher"}, -and \code{"jenks"}. If both \code{x} and \code{y} are factors, this argument can -be omitted.} + supported styles are \code{"quantile"}, \code{"equal"}, \code{"fisher"}, + and \code{"jenks"}. If both \code{x} and \code{y} are factors, this argument can + be omitted. + + Note that older versions of \code{biscale} used \code{"quantile"} as the default + for this argument. Now that \code{bi_class} accepts factors, this argument + no longer as a default and older code will error.} \item{dim}{The dimensions of the palette. To use the built-in palettes, this value must be either \code{2}, \code{3}, or \code{4}. A value of diff --git a/man/bi_pal.Rd b/man/bi_pal.Rd index fcf3009..8aca947 100755 --- a/man/bi_pal.Rd +++ b/man/bi_pal.Rd @@ -59,9 +59,11 @@ Prints either a visual preview of each palette or the associated \details{ The \code{"Brown"}, \code{"DkBlue"}, \code{"DkCyan"}, and \code{"GrPink"} palettes were made by - \href{http://www.joshuastevens.net/cartography/make-a-bivariate-choropleth-map/}{Joshua Stevens}. + \href{https://www.joshuastevens.net/cartography/make-a-bivariate-choropleth-map/}{Joshua Stevens}. The \code{"DkViolet"} palette was made by \href{https://timogrossenbacher.ch/2019/04/bivariate-maps-with-ggplot2-and-sf/}{Timo Grossenbacher and Angelo Zehr}. + Many of the new palettes were inspired by Branson Fox's earlier work to expand + \code{biscale}. } \examples{ # gray pink palette, 2x2 diff --git a/man/figures/pal_border.png b/man/figures/pal_border.png deleted file mode 100644 index 13c9e21..0000000 Binary files a/man/figures/pal_border.png and /dev/null differ diff --git a/man/figures/pals_legancy.jpeg b/man/figures/pals_legacy.jpeg similarity index 100% rename from man/figures/pals_legancy.jpeg rename to man/figures/pals_legacy.jpeg diff --git a/vignettes/bivariate_palettes.Rmd b/vignettes/bivariate_palettes.Rmd index 0813016..275c561 100644 --- a/vignettes/bivariate_palettes.Rmd +++ b/vignettes/bivariate_palettes.Rmd @@ -33,7 +33,7 @@ Most of the newly added palettes not based on legacy designs were adapted from e To ensure compatibility with scripts written with older versions of `biscale`, the original five palettes included in the package are still available. They can be used only for two-by-two (`dim = 2`) and three-by-three (`dim = 3`) maps. ```{r echo=FALSE, out.width='100%'} -knitr::include_graphics('../man/figures/pals_legancy.jpeg') +knitr::include_graphics('../man/figures/pals_legacy.jpeg') ``` The `"DkViolet"` palette was created by [Timo Grossenbacher and Angelo Zehr](https://timogrossenbacher.ch/2019/04/bivariate-maps-with-ggplot2-and-sf/), and the other four palettes were created by [Joshua Stevens](https://www.joshuastevens.net/cartography/make-a-bivariate-choropleth-map/).