Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/corner/arviz_corner.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ def arviz_corner(
label_kwargs=None,
titles=None,
show_titles=False,
title_quantiles=None,
wrap_title_quantiles=False,
title_fmt=".2f",
title_kwargs=None,
truths=None,
Expand Down Expand Up @@ -187,6 +189,8 @@ def arviz_corner(
label_kwargs=label_kwargs,
titles=titles,
show_titles=show_titles,
title_quantiles=title_quantiles,
wrap_title_quantiles=wrap_title_quantiles,
title_fmt=title_fmt,
title_kwargs=title_kwargs,
truths=truths,
Expand Down
7 changes: 6 additions & 1 deletion src/corner/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ def corner_impl(
scale_hist=False,
quantiles=None,
title_quantiles=None,
wrap_title_quantiles=False,
verbose=False,
fig=None,
max_n_ticks=5,
Expand Down Expand Up @@ -277,7 +278,11 @@ def corner_impl(

# Add in the column name if it's given.
if titles is not None:
title = "{0} = {1}".format(titles[i], title)
# Wrap the quantiles below the column name if asked
if wrap_title_quantiles:
title = "{0} =\\n{1}".format(titles[i], title)
else:
title = "{0} = {1}".format(titles[i], title)

elif titles is not None:
title = "{0}".format(titles[i])
Expand Down
10 changes: 10 additions & 0 deletions src/corner/corner.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ def corner(
titles=None,
show_titles=False,
title_quantiles=None,
wrap_title_quantiles=False,
title_fmt=".2f",
title_kwargs=None,
truths=None,
Expand Down Expand Up @@ -148,6 +149,13 @@ def corner(
errors. If `None` (default), inherit the values from quantiles, unless
quantiles is `None`, in which case it defaults to [0.16,0.5,0.84]

wrap_title_quantiles : bool
If ``True``, and if quantile values are being shown in the titles,
place the parameter name and the formatted quantile summary on
separate lines. This only affects automatically generated quantile
titles when ``show_titles=True`` and ``title_fmt`` is not ``None``.
If ``False`` (default), they are shown on a single line.

title_fmt : string or iterable (ndim,)
The format string for the quantiles given in titles for eachimension.
If you explicitly set ``show_titles=True`` and ``title_fmt=None``,
Expand Down Expand Up @@ -260,6 +268,7 @@ def corner(
titles=titles,
show_titles=show_titles,
title_quantiles=title_quantiles,
wrap_title_quantiles=wrap_title_quantiles,
title_fmt=title_fmt,
title_kwargs=title_kwargs,
truths=truths,
Expand Down Expand Up @@ -292,6 +301,7 @@ def corner(
titles=titles,
show_titles=show_titles,
title_quantiles=title_quantiles,
wrap_title_quantiles=wrap_title_quantiles,
title_fmt=title_fmt,
title_kwargs=title_kwargs,
truths=truths,
Expand Down