pyplotbrookings 0.1.2

A plotting package for the Brookings Institution

pyplotbrookings

Overview

pyplotbrookings is a matplotlib extension which implements the Brookings Institution style guide. It offers several color palettes, a custom theme, and a few helper functions. pyplotbrookings is a python implementation of ggbrookings, an R extension for ggplot.

Installation

pyplotbrookings is now a python package! It downloaded from PyPI with pip (https://pypi.org/project/pyplotbrookings/)!

pip install pyplotbrookings

The accepted alias for pyplotbrookings is ppb. For example,

import pyplotbrookings.pyplotbrookings as ppb

Usage

The pyplotbrookings package has a few simple user facing functions:

• set_theme() overrides the default matplotlib theme for a custom one which adheres to the Brookings style guide.

• get_palette() returns the colors for a valid Brookings brand palettes.

• set_palette() sets the matplotlib color cycler to one of the Brookings brand palettes.

  • Valid color palettes are: default, brand1, brand2, analogous1, analogous2, contrasting1, contrasting2, semantic1, semantic2, semantic3, pos_neg1, pos_neg2, political1, political2 political3, political4, categorical, sequential1, sequential2, diverging, misc, brand blue, vivid blue, teal, green, yellow, orange, red, magenta, purple

• get_cmap() returns a continuous palette (or color map) using one of the color Brookings color palettes.

• view_palette() helper function that previews a color palette showing the color, order, and the appropriate text color that can be applied on top of each color.

• add_title() adds titles and subtitles to a figure that are consistent with Brookings brand guidelines.

• add_notes() adds notes to the bottom of a figure also consistent with Brookings brand guidelines.

• add_logo() adds a program/center logo to a figure.

  • You can add a logo using a local path or use one of the logos that comes with pyplotbrookings.
  • The following logos are included with pyplotbrookings: bc (Brown Center), bi (Bass Initiative on Innovation and Placemaking), brookings (Brookings Institution), cc (China Center), ccf (Center on Children and Families), ceaps (Center for East Asia Policy Studies), cepm (Center for Effective Policy Management), chp (Center for Health Policy), cmep (Center for Middle Eastern Policy), crm (Center on Regulation and Markets), csd (Center for Sustainable Development), cti (Center for Technology Innovation), cue (Center for Universal Education), cuse (Center on United States and Europe), es (Economic Studies), fp (Foreign Policy), global (Global Studies), gs (Governance Studies), hc (Hutchins Center), metro (Metropolitan Policy Studies), thp (The Hamilton Project).

• figure() creates a matplotlib figure in one of the standard Brookings sizes.

• save() saves a figure in the Brookings advised dpi values depending on content type.

Contact

To report any bugs or discuss contributing to this package please contact Adam Sedlak or Valerie Wirtschafter.

Examples

Let's create a figure plot using pyplotbrookings. First we'll need some data

import matplotlib.pyplot as plt
import pyplotbrookings.pyplotbrookings as ppb
import seaborn as sns

# Brookings plot theme for all plots
ppb.set_theme()

# Getting data
penguins = sns.load_dataset("penguins")

Now we can create a figure using the following

# Reversing data to get the correct z-order ordering of plots
ax = sns.histplot(data=penguins.iloc[::-1], 
                  x='bill_depth_mm', 
                  hue='species', 
                  # Setting the plot palette to Brookings brand2
                  palette=ppb.get_palette('brand2'), 
                  bins=20)

# Moving the legend in seaborn to the top
sns.move_legend(ax, "lower center", bbox_to_anchor=(.5, 1.05), ncol=3, title=None, frameon=False)
plt.xlabel('Bill Depth (mm)')

# Adding Brookings titles
ppb.add_title(title='Penguin Bill Depth', 
              subtitle='Bill Depth in mm of Adelie and Gentoo Penguins at Palmer Station LTER', 
              tag='FIGURE 1B')

# Adding notes
ppb.add_notes('Source: Palmer Station Antarctica LTER', 
              'Notes: Figure made using matplotlib')

ppb.add_logo('hc')

pyplotbrookings is designed to work with many different plots. Let's try creating a scatter plot that uses a colormap

# Getting the Brookings sequential2 color map
cmap = ppb.get_cmap('sequential2', reverse=True)
# Creating a scatter plot
plt.scatter(data=penguins, x='bill_length_mm', y='bill_depth_mm', c='flipper_length_mm', cmap=cmap)

# Adding matplotlib legend/labels
plt.xlabel('Bill Length (mm)')
plt.ylabel('Bill Depth (mm)')

# Adding color bar
cbar = plt.colorbar(cmap=cmap)
cbar.set_label('Flipper Length (mm)')
cbar.outline.set_visible(False)

# Adding Brookings titles
ppb.add_title(title='Penguin Bills and Flippers', 
              subtitle='Bill length vs. Bill Depth vs. Flipper Length of Penguins at\nPalmer Station', 
              tag='FIGURE 2')

# Adding notes
ppb.add_notes('Source: Palmer Station Antarctica LTER',
              'Example: Here is some extra long text that\ngoes on and on and needs a linefeed.',
              'Notes: Figure made using matplotlib')

# Adding a CRM logo
ppb.add_logo('crm', scale=0.35, offsets=(-0.1, 0))

We could also create a box plot. Note that titles and notes auto-align to the left margin of the figure.

# Creating a boxplot
sns.boxplot(data=penguins, x='bill_depth_mm', y='island', palette=ppb.get_palette('misc'))


# Adding Brookings titles
ppb.add_title(title='Penguin Bills Depth', 
              subtitle='Length of Penguin Bills on each Island', 
              tag='FIGURE 3')

# Adding notes
ppb.add_notes('Source: Palmer Station Antarctica LTER', 
              'Notes: Figure made using matplotlib')


# Adding matplotlib legend/labels
plt.xlabel('Bill Depth (mm)')
plt.ylabel('Island')

ppb.add_logo('crm', scale=0.35, offsets=(-0.1, 0))