question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

ENH: plot_topomap, plot_joint & plot: API homogeneity for scalings/scale parameters

See original GitHub issue

Small API heterogenity: different plotting functions use similar parameters slightly differently (and named slightly differently)

  • scaling: evoked.plot(scalings=dict()) but evoked.plot_topomap(scale=dict() | float)
  • units: evoked.plot(units=dict()) but evoked.plot_topomap(unit=dict() | str)
  • max amplitude: evoked.plot(ylim=dict()) but evoked.plot_topomap(vmin=dict() | float, vmax=dict() | float())

Changing parameter names can be annoying for deprecation, but I suggest we at least make their input similar (e.g. always accepts both dict and float).

Additionally, evoked.plot_joint() could gather the parameters common to plot() and plot_topomap() to simplify it. WDTY @jona-sassenhagen ?

Issue Analytics

  • State:closed
  • Created 7 years ago
  • Comments:12 (12 by maintainers)

github_iconTop GitHub Comments

1reaction
jona-sassenhagencommented, Oct 27, 2016

Can we split this into multiple smaller PRs?

0reactions
larsonercommented, Dec 7, 2016

Oh it is in the top post.

I think the only clean way to fix it is to deprecate.

Read more comments on GitHub >

github_iconTop Results From Across the Web

mne.viz.plot_topomap — MNE 1.2.2 documentation
Plot a topographic map as image. Parameters: data array , shape (n_chan,). The data values to plot ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found