suggested option and documentation additions to plot functions #33
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I noticed a few small things about the plotting functions and their associated documentation that I thought could be improved, and am proposing the following changes:
plot_pep()
andplot_map()
function documentation indicates low, high, and mid color options, but I believe the functions have changed in the meantime to accept a palette argument instead. I updated the documentation accordingly.plot_pep()
andplot_map()
with the new default color palette, which results in white font on very light background in some places, so suggested adding optionstext_color
andtile_color
so that the user can change both the text color and associated tile color if desired. Both still default to "white" as before.plot_pep()
andplot_map()
, including the examples, indicated that the full object produced by a call tomem_exact()
ormem_mcmc()
was passed to these functions, but in fact they take thebasket
element of the object. I updated the input description as well as the examples correspondingly.plot_map()
so I suggest removing it entirelyplot_map()
to be the same as that produced byplot_pep()
so that the resulting plots could more easily be placed side-by-side.