standardize plotting API

latest-generation plotting functions all contain the following boilerplate:

# honor ax
if ax is not None:
    plt.sca(ax)

# clear figure if plotting in `outfile` mode
if outfile is not None:
    plt.clf()

# prepare sns
sns.set(color_codes=True)
sns.set_style('ticks')

<actual plotting steps>

# save figure
if outfile is not None:
    check_outdir(outfile)
    if plot_kwargs:
        adjust_plot(**plot_kwargs)
    plt.savefig(outfile, bbox_inches='tight')

return plt.gca()

it sounds like we could just write a decorator to do all of this

clients of the decorator could write

@plotter
def plot_whatever(data, **kwargs):
    plt.scatter(data[0], data[1])

and clients of the decorated function could make calls like

plot_whatever([x, y], ax=special_ax)
plot_whatever([x, y], outfile='whatever.png')
plot_whatever([x, y], xlabel='whatever')

the decorator would first check

ax = kwargs.get('ax')
outfile = kwargs.get('ax')
plot_kwargs = {key: kwargs.get(key) for key in inspect.getargspec(adjust_plot)[0]}

this would immediately fix the "plotters" half of #9

it would also fix ~~#22~~

Comments (1)