ggexpanse/README.md

[![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-77.8%25-lightgrey.svg)
[![Linux build
Status](https://travis-ci.org/hrbrmstr/ggexpanse.svg?branch=master)](https://travis-ci.org/hrbrmstr/ggexpanse)  
![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)

# ggexpanse

Theme Elements Based On ‘The Expanse’

## Description

Plot aesthetic defaults and theme elements inspired by ‘The Expanse’.

## What’s Inside The Tin

A copy of the [Protomolecule
Font](https://www.reddit.com/r/TheExpanse/comments/ay322l/protomolecule_font/).

The following functions are implemented:

  - `expanse_cols`: Colors from The Expanse (WIP)
  - `expanse_pal`: Color palette based on selected colors from
    expanse\_cols
  - `import_protomolecule`: Import Protomolecule font for use in charts
  - `protomolecule`: Helper to get the right font name for varous
    operating systems
  - `scale_colour_expanse`: Discrete color & fill scales based on “The
    Expanse” palette
  - `theme_expanse`: An “Expanse” theme for ggplot2

## Installation

``` r
install.packages("ggexpanse", repos = "https://cinc.rud.is")
# or
remotes::install_git("https://git.rud.is/hrbrmstr/ggexpanse.git")
# or
remotes::install_git("https://git.sr.ht/~hrbrmstr/ggexpanse")
# or
remotes::install_gitlab("hrbrmstr/ggexpanse")
# or
remotes::install_bitbucket("hrbrmstr/ggexpanse")
# or
remotes::install_github("hrbrmstr/ggexpanse")
```

NOTE: To use the ‘remotes’ install options you will need to have the
[{remotes} package](https://github.com/r-lib/remotes) installed.

## Usage

``` r
library(ggexpanse)

# current version
packageVersion("ggexpanse")
## [1] '0.1.0'

extrafont::loadfonts(quiet=TRUE)
```

``` r
scales::show_col(as.character(expanse_cols))
```

<img src="man/figures/README-pal1-1.png" width="672" />

``` r
scales::show_col(expanse_palette)
```

<img src="man/figures/README-pal2-1.png" width="672" />

``` r
ggplot() +
  geom_smooth(
    data = mtcars, method = "lm", 
    aes(wt, mpg), colour = "white", 
    fill = "gray60", show.legend = FALSE
  ) +
  geom_point(
    data = mtcars,
    aes(wt, mpg, fill = factor(carb)), 
    shape = 21, color = "gray60", size = 4
  ) +
  scale_colour_expanse() +
  scale_fill_expanse() +
  labs(
    title = "Stars Are Better_Off Without Us",
    subtitle = "Say what you_will about organized_crime, at least it’s organized."
  ) +
  theme_expanse(grid = "XY")
```

<img src="man/figures/README-plotex-1.png" width="768" />

## ggexpanse Metrics

| Lang | \# Files |  (%) | LoC |  (%) | Blank lines |  (%) | \# Lines | (%) |
| :--- | -------: | ---: | --: | ---: | ----------: | ---: | -------: | --: |
| R    |        7 | 0.88 | 220 | 0.88 |          43 | 0.68 |       80 | 0.7 |
| Rmd  |        1 | 0.12 |  29 | 0.12 |          20 | 0.32 |       34 | 0.3 |

## Code of Conduct

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.