diff --git a/README.Rmd b/README.Rmd index 910b956..4556b64 100644 --- a/README.Rmd +++ b/README.Rmd @@ -4,15 +4,12 @@ editor_options: chunk_output_type: console --- ```{r pkg-knitr-opts, include=FALSE} -knitr::opts_chunk$set( - collapse = TRUE, fig.retina = 2, message = FALSE, warning = FALSE -) -options(width=120) +hrbrpkghelpr::global_opts() ``` -[![Travis-CI Build Status](https://travis-ci.org/hrbrmstr/ggeconodist.svg?branch=master)](https://travis-ci.org/hrbrmstr/ggeconodist) -[![Coverage Status](https://codecov.io/gh/hrbrmstr/ggeconodist/branch/master/graph/badge.svg)](https://codecov.io/gh/hrbrmstr/ggeconodist) -[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/ggeconodist)](https://cran.r-project.org/package=ggeconodist) +```{r badges, results='asis', echo=FALSE, cache=FALSE} +hrbrpkghelpr::stinking_badges() +``` # ggeconodist @@ -36,7 +33,7 @@ The following functions are implemented: ## Installation -```{r install-ex, results='asis', echo = FALSE} +```{r install-ex, results='asis', echo=FALSE, cache=FALSE} hrbrpkghelpr::install_block() ``` @@ -54,7 +51,7 @@ packageVersion("ggeconodist") **YOU WILL NEED** to install [these fonts](https://github.com/economist-components/component-typography) to use the built-in theme. More on how to do that at some point. -```{r} +```{r mam} ggplot(mammogram_costs, aes(x = city)) + geom_econodist( aes(ymin = tenth, median = median, ymax = ninetieth), @@ -76,7 +73,7 @@ left_align(gg, c("subtitle", "title", "caption")) %>% grid.draw() ``` -```{r} +```{r mpg} library(dplyr) library(patchwork) library(hrbrthemes) @@ -133,11 +130,10 @@ gmgg %>% ## ggeconodist Metrics -```{r cloc, echo=FALSE} +```{r cloc, echo = FALSE} cloc::cloc_pkg_md() ``` ## Code of Conduct -Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). -By participating in this project you agree to abide by its terms. +Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. diff --git a/README.md b/README.md index 6f1ae98..629810e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,18 @@ -[![Travis-CI Build +[![Project Status: Active – The project has reached a stable, usable +state and is being actively +developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) +[![Signed +by](https://img.shields.io/badge/Keybase-Verified-brightgreen.svg)](https://keybase.io/hrbrmstr) +![Signed commit +%](https://img.shields.io/badge/Signed_Commits-100%25-lightgrey.svg) +[![Linux build Status](https://travis-ci.org/hrbrmstr/ggeconodist.svg?branch=master)](https://travis-ci.org/hrbrmstr/ggeconodist) [![Coverage Status](https://codecov.io/gh/hrbrmstr/ggeconodist/branch/master/graph/badge.svg)](https://codecov.io/gh/hrbrmstr/ggeconodist) -[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/ggeconodist)](https://cran.r-project.org/package=ggeconodist) +![Minimal R +Version](https://img.shields.io/badge/R%3E%3D-3.2.0-blue.svg) +![License](https://img.shields.io/badge/License-MIT-blue.svg) # ggeconodist @@ -37,17 +46,20 @@ The following functions are implemented: ``` r install.packages("ggeconodist", repos = "https://cinc.rud.is") # or -devtools::install_git("https://git.rud.is/hrbrmstr/ggeconodist.git") +remotes::install_git("https://git.rud.is/hrbrmstr/ggeconodist.git") # or -devtools::install_git("https://git.sr.ht/~hrbrmstr/ggeconodist") +remotes::install_git("https://git.sr.ht/~hrbrmstr/ggeconodist") # or -devtools::install_gitlab("hrbrmstr/ggeconodist") +remotes::install_gitlab("hrbrmstr/ggeconodist") # or -devtools::install_bitbucket("hrbrmstr/ggeconodist") +remotes::install_bitbucket("hrbrmstr/ggeconodist") # or -devtools::install_github("hrbrmstr/ggeconodist") +remotes::install_github("hrbrmstr/ggeconodist") ``` +NOTE: To use the ‘remotes’ install options you will need to have the +[{remotes} package](https://github.com/r-lib/remotes) installed. + ## Usage ``` r @@ -86,7 +98,7 @@ left_align(gg, c("subtitle", "title", "caption")) %>% grid.draw() ``` - + ``` r library(dplyr) @@ -101,7 +113,7 @@ p <- ggplot(mpg, aes(class, hwy)) + theme_ipsum_rc() plot_layout(ncol = 1) ``` - + ``` r @@ -111,7 +123,7 @@ p <- ggplot(mpg, aes(class, hwy)) + theme_ipsum_rc() plot_layout(ncol = 1) ``` - + ``` r @@ -120,7 +132,7 @@ p <- ggplot(mpg, aes(class, hwy)) + theme_ipsum_rc() plot_layout(ncol = 1) ``` - + ``` r gapminder %>% @@ -155,17 +167,17 @@ gmgg %>% grid.draw() ``` - + ## ggeconodist Metrics | Lang | \# Files | (%) | LoC | (%) | Blank lines | (%) | \# Lines | (%) | | :--- | -------: | ---: | --: | ---: | ----------: | ---: | -------: | ---: | -| R | 10 | 0.91 | 398 | 0.85 | 76 | 0.72 | 128 | 0.75 | -| Rmd | 1 | 0.09 | 71 | 0.15 | 30 | 0.28 | 42 | 0.25 | +| R | 10 | 0.91 | 398 | 0.85 | 76 | 0.72 | 137 | 0.77 | +| Rmd | 1 | 0.09 | 69 | 0.15 | 30 | 0.28 | 40 | 0.23 | ## Code of Conduct -Please note that this project is released with a [Contributor Code of -Conduct](CONDUCT.md). By participating in this project you agree to -abide by its terms. +Please note that this project is released with a Contributor Code of +Conduct. By participating in this project you agree to abide by its +terms. diff --git a/README_files/figure-gfm/gm-1.png b/README_files/figure-gfm/gm-1.png deleted file mode 100644 index 2dd0962..0000000 Binary files a/README_files/figure-gfm/gm-1.png and /dev/null differ diff --git a/README_files/figure-gfm/unnamed-chunk-1-1.png b/README_files/figure-gfm/unnamed-chunk-1-1.png deleted file mode 100644 index 2091941..0000000 Binary files a/README_files/figure-gfm/unnamed-chunk-1-1.png and /dev/null differ diff --git a/README_files/figure-gfm/unnamed-chunk-2-1.png b/README_files/figure-gfm/unnamed-chunk-2-1.png deleted file mode 100644 index 375bdb2..0000000 Binary files a/README_files/figure-gfm/unnamed-chunk-2-1.png and /dev/null differ diff --git a/README_files/figure-gfm/unnamed-chunk-2-2.png b/README_files/figure-gfm/unnamed-chunk-2-2.png deleted file mode 100644 index fe7c05b..0000000 Binary files a/README_files/figure-gfm/unnamed-chunk-2-2.png and /dev/null differ diff --git a/README_files/figure-gfm/unnamed-chunk-2-3.png b/README_files/figure-gfm/unnamed-chunk-2-3.png deleted file mode 100644 index 3201007..0000000 Binary files a/README_files/figure-gfm/unnamed-chunk-2-3.png and /dev/null differ diff --git a/man/figures/README-gm-1.png b/man/figures/README-gm-1.png new file mode 100644 index 0000000..52df3aa Binary files /dev/null and b/man/figures/README-gm-1.png differ diff --git a/man/figures/README-mam-1.png b/man/figures/README-mam-1.png new file mode 100644 index 0000000..4fe4b3f Binary files /dev/null and b/man/figures/README-mam-1.png differ diff --git a/man/figures/README-mpg-1.png b/man/figures/README-mpg-1.png new file mode 100644 index 0000000..35f23a8 Binary files /dev/null and b/man/figures/README-mpg-1.png differ diff --git a/man/figures/README-mpg-2.png b/man/figures/README-mpg-2.png new file mode 100644 index 0000000..ccd33f1 Binary files /dev/null and b/man/figures/README-mpg-2.png differ diff --git a/man/figures/README-mpg-3.png b/man/figures/README-mpg-3.png new file mode 100644 index 0000000..2f81276 Binary files /dev/null and b/man/figures/README-mpg-3.png differ