diff --git a/README.Rmd b/README.Rmd index 08e4304..24709b8 100644 --- a/README.Rmd +++ b/README.Rmd @@ -4,41 +4,32 @@ editor_options: chunk_output_type: console --- -[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) -[![Build Status](https://travis-ci.org/hrbrmstr/statebins.svg?branch=master)](https://travis-ci.org/hrbrmstr/statebins) -[![minimal R version](https://img.shields.io/badge/R%3E%3D-3.2.0-6666ff.svg)](https://cran.r-project.org/) -[![packageversion](https://img.shields.io/badge/Package%20version-2.0.0-orange.svg?style=flat-square)](commits/master) -![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/statebins) -[![](http://cranlogs.r-pkg.org/badges/statebins)](http://cran.rstudio.com/web/packages/statebins/index.html) -[![Travis-CI Build Status](https://travis-ci.org/hrbrmstr/statebins.svg?branch=master)](https://travis-ci.org/hrbrmstr/statebins) -[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/hrbrmstr/statebins?branch=master&svg=true)](https://ci.appveyor.com/project/hrbrmstr/statebins) - -```{r include=FALSE} -knitr::opts_chunk$set(message=FALSE, warning=FALSE) +```{r pkg-knitr-opts, include=FALSE} +hrbrpkghelpr::global_opts() ``` -# statebins +```{r badges, results='asis', echo=FALSE, cache=FALSE} +hrbrpkghelpr::stinking_badges() +``` -Create 'U.S.' Uniform Square State Cartogram Heatmaps +```{r description, results='asis', echo=FALSE, cache=FALSE} +hrbrpkghelpr::yank_title_and_description() +``` -## What's in the tin? +## What's Inside The Tin The following functions are implemented: -- `statebins`: Creates "statebin" charts in the style of http://bit.ly/statebins -- `geom_statebins`: A statebins Geom (WIP!) -- `theme_statebins`: Base statebins theme +```{r ingredients, results='asis', echo=FALSE, cache=FALSE} +hrbrpkghelpr::describe_ingredients() +``` ## Installation -```{r install, eval=FALSE} -devtools::install_github("hrbrmstr/statebins") +```{r install-ex, results='asis', echo=FALSE, cache=FALSE} +hrbrpkghelpr::install_block() ``` -## NOTE - -Due to a number of things, this is dependent on the _development_ version of ggplot2 and now identifies that in the `DESCRIPTION` metadata, _including_ a `Remotes:` field (which will be removed when this & ggplot2 hit CRAN). - ## Usage All of the following examples use the [WaPo data](http://www.washingtonpost.com/wp-srv/special/business/states-most-threatened-by-trade/states.csv?cache=1). It looks like the columns they use are scaled data and I didn't take the time to figure out what they did, so the final figure just mimics their output (including the non-annotated legend). diff --git a/man/figures/README-all-1.png b/man/figures/README-all-1.png new file mode 100644 index 0000000..c7540ce Binary files /dev/null and b/man/figures/README-all-1.png differ diff --git a/man/figures/README-continuous-1.png b/man/figures/README-continuous-1.png new file mode 100644 index 0000000..5ac48ca Binary files /dev/null and b/man/figures/README-continuous-1.png differ diff --git a/man/figures/README-continuous_noleg-1.png b/man/figures/README-continuous_noleg-1.png new file mode 100644 index 0000000..4724301 Binary files /dev/null and b/man/figures/README-continuous_noleg-1.png differ diff --git a/man/figures/README-fert-1.png b/man/figures/README-fert-1.png new file mode 100644 index 0000000..28d0ea5 Binary files /dev/null and b/man/figures/README-fert-1.png differ diff --git a/man/figures/README-manual-1.png b/man/figures/README-manual-1.png new file mode 100644 index 0000000..8cee71e Binary files /dev/null and b/man/figures/README-manual-1.png differ diff --git a/man/figures/README-mort-1.png b/man/figures/README-mort-1.png new file mode 100644 index 0000000..e91e6fa Binary files /dev/null and b/man/figures/README-mort-1.png differ diff --git a/man/figures/README-original-1.png b/man/figures/README-original-1.png new file mode 100644 index 0000000..e2e5edc Binary files /dev/null and b/man/figures/README-original-1.png differ diff --git a/man/figures/README-rounded-1.png b/man/figures/README-rounded-1.png new file mode 100644 index 0000000..0fa4929 Binary files /dev/null and b/man/figures/README-rounded-1.png differ diff --git a/man/figures/README-rounded2-1.png b/man/figures/README-rounded2-1.png new file mode 100644 index 0000000..a910773 Binary files /dev/null and b/man/figures/README-rounded2-1.png differ diff --git a/man/figures/README-sb_facet-1.png b/man/figures/README-sb_facet-1.png new file mode 100644 index 0000000..3d83338 Binary files /dev/null and b/man/figures/README-sb_facet-1.png differ