added Ishikawa plot in response to issue #25222 add organizational ch… #25248

rbt94 · 2023-02-18T08:09:53Z

…arts to supported plots

PR Summary

PR Checklist

Documentation and Tests

Has pytest style unit tests (and pytest passes)
Documentation is sphinx and numpydoc compliant (the docs should build without error).
New plotting related features are documented with examples.

Release Notes

New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

…ational charts to supported plots

github-actions

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

rcomer · 2023-02-18T18:00:51Z

Thank you for your contribution @rbt94! It looks like there are some style problems that need fixing, shown by the automated checks. So I'm going to mark this as "draft" for now. Please mark it as "ready for review" when you are ready. In the meantime, if you need help, feel free to ask questions here. Or you may prefer to ask them in our incubator gitter room.

rbt94 · 2023-02-19T10:39:10Z

sorry @rcomer I have modified the code and I wanted to rerun the github checks before "marking for review" the code. Could you please describe to me the procedure before actually review the code? Sorry but I am pretty new to github. Thanks a lot

jklymak · 2023-02-19T17:10:43Z

examples/specialty_plots/ishikawa.py

        Maximum recursion level set. The default is 4.
-    DEBUG : bool, optional
+    debug : bool, optional


Suggest use the logging module instead of manual debugging.

using the logging you can also emit to the logger, but it the log level is set higher it will be automatically dropped so you do not need to thread this parameter through.

jklymak · 2023-02-19T17:12:43Z

examples/specialty_plots/ishikawa.py

+
+    fig.savefig(output_path,


Please do not add savefig calls in examples. Don't need show, and probably don't need to encapsulate in a __main__.

To elaborate a bit more, the way our documentation build system works is we run the examples and then find and show any figures that are created.

While using '__main__' is a good practice for stand-alone scripts, will effectively hide the example from the docs which will in turn prevent the rendered image from showing up in the build docs!

jklymak · 2023-02-19T17:13:03Z

examples/specialty_plots/ishikawa.py

-    '''
-
+
+def ishikawaplot(data, figsize=(20, 10), left_margin: float = 0.05, right_margin: float = 0.05, alpha_ps: float = 60.0,


We have an 88-character line limit. Please wrap...

tacaswell · 2023-02-20T15:11:40Z

.flake8

@@ -92,6 +92,7 @@ per-file-ignores =
    examples/lines_bars_and_markers/marker_reference.py: E402
    examples/misc/print_stdout_sgskip.py: E402
    examples/misc/table_demo.py: E201
+	examples/specialty_plots/ishikawa.py: E501


Please wrap the example instead of adding an exception for it.

tacaswell · 2023-02-20T15:20:44Z

I have modified the code and I wanted to rerun the github checks before "marking for review" the code.

if you install flake8 and invoke it from the top level of our docs you should catch most of the formatting issues. To be more through you can also install pre-commit (see https://matplotlib.org/devdocs/devel/development_setup.html#install-pre-commit-hooks-optional) which will run the exact same checks locally for you.

scottshambaugh · 2023-02-20T15:57:17Z

examples/specialty_plots/ishikawa.py

+Ishikawa Diagrams
+===============
+
+Ishikawa Diagrams are useful for visualizing the effect to many cause relationships


Wikipedia says that these are also known as "fishbone diagrams, herringbone diagrams, and cause-and-effect diagrams". Could you add those alternate names to the description so they show up in a search?

It may also be good to link to Wikipedia so that readers can find additional information on this plot type.

rbt94 · 2023-02-20T17:03:19Z

Thank you guys, in a few days I will revise the code with your comments and run the checks also locally. Best, Robert Il lun 20 feb 2023, 16:57 Scott Shambaugh ***@***.***> ha scritto:

…

***@***.**** commented on this pull request. ------------------------------ In examples/specialty_plots/ishikawa.py <#25248 (comment)> : > @@ -0,0 +1,228 @@ +""" +=============== +Ishikawa Diagrams +=============== + +Ishikawa Diagrams are useful for visualizing the effect to many cause relationships Wikipedia says <https://en.wikipedia.org/wiki/Ishikawa_diagram> that these are also known as "fishbone diagrams, herringbone diagrams, and cause-and-effect diagrams". Could you add those alternate names to the description so they show up in a search? — Reply to this email directly, view it on GitHub <#25248 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AVDSMTIT3CCW4GFTUYVG4HTWYOH6TANCNFSM6AAAAAAVAGT6GU> . You are receiving this because you were mentioned.Message ID: ***@***.***>

- improved example description docstring - removed __main__ call - debug print converted into logging.debug strings - removed sohw fig and save fig and related Path library - removed exception from flake8 conf file

rbt94 · 2023-02-21T18:56:49Z

Hello @matplotlib/developers I have implemented the reported modifications and passed the pre-commit checks before committing. Unfortunately I cannot reach a successful test of the entire commit. Can you please help me by indicating what else needs to be fixed in order to pass the test? Is it the sphinx warning "Title overline too short" or something else?

Thank you,
Robert

examples/specialty_plots/ishikawa.py

scottshambaugh · 2023-02-21T19:28:12Z

I left a comment indicating how to fix the sphinx build error. I believe the Main Pytest Windows_py311 failure is a random CI timeout, let's see if it passes when you push up that change and it runs again. If it's consistent then I believe it's a separate issue from your code changes that we'll have to look into.

rbt94 · 2023-02-22T10:05:35Z

Thank you @scottshambaugh. It is now sufficient to mark for review or there are any other issue to fix? I do not know how codecov works.

Thanks

tacaswell · 2023-02-22T23:33:48Z

https://output.circle-artifacts.com/output/job/d403deed-735c-486b-aa3b-6ee206015be8/artifacts/0/doc/build/html/gallery/specialty_plots/ishikawa.html#sphx-glr-gallery-specialty-plots-ishikawa-py is the rendered output

jklymak · 2023-02-23T00:08:24Z

examples/specialty_plots/ishikawa.py

+    return None
+
+
+def ishikawaplot(data, figsize=(20, 10), left_margin: float = 0.05,


This method really just acts on a single axes. Strongly suggest re-structuring without figsize and just passing in an axes. If no axes is passed in, then make a new figure, and return the new axes.

Disable discarded animation warning on save

Pin sphinx themes more strictly

Fixes matplotlib#25365

By combining A/B parameters, to match the style of the CurveBracket, CurveFilled, etc. Also, tweak the example image so that it is not scaled down in the docs, and explicitly shows 0°.

BLD: Pre-download Qhull license to put in wheels

Tk: Fix size of spacers when changing display DPI

Clean up Curve ArrowStyle docs

"Inactive" workflow: bump operations-per-run

…ational charts to supported plots

- improved example description docstring - removed __main__ call - debug print converted into logging.debug strings - removed sohw fig and save fig and related Path library - removed exception from flake8 conf file

- added wikipedia link to ishikawa desc doc string - reformatted function def to work on axes object - fix plt.tight_layout leaving the user to choose - reduced fisize still mantaining a decent rendering - added swotplot.py for SWOT plots with the same logic, design pattern and style

…kawa_example into my-feature

rbt94 · 2023-03-04T10:04:13Z

I'm not sure that the input data on either of these functions needs to be a dictionary. The names and data are paired, but don't seem to be inherently dictionary-like.

The logic and formatting I have used was to resemble a plain JSON file format, just to speed-up operations in a larger application.

- integrated hypot call instead sqrt formula - fix dict iteration - debug eliminated - alpha vars renaming - docstrings minor fixes

melissawm · 2023-03-29T12:00:01Z

Hi @rbt94 - it looks like something went wrong with a rebase? Do you need help fixing this or moving the PR forward?

rbt94 · 2023-04-08T06:04:22Z

Thank you Melissa it would be very appreciated. Currently I have applied for a second job and I have not so spare time to dedicate into this. Sorry about that. <https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail> Privo di virus.www.avast.com <https://www.avast.com/sig-email?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail> <#DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2> Il giorno mer 29 mar 2023 alle ore 14:00 Melissa Weber Mendonça < ***@***.***> ha scritto:

…

Hi @rbt94 <https://github.com/rbt94> - it looks like something went wrong with a rebase? Do you need help fixing this or moving the PR forward? — Reply to this email directly, view it on GitHub <#25248 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AVDSMTMFNKVXWX5P72TNBPDW6QP43ANCNFSM6AAAAAAVAGT6GU> . You are receiving this because you were mentioned.Message ID: ***@***.***>

-- Bodo Roberto

melissawm · 2023-04-13T18:37:03Z

@rbt94 no worries, would you prefer trying to solve this or could another contributor take over your PR, as long as they keep you as a co-author? Cheers!

rbt94 · 2023-04-15T15:01:30Z

@rbt94 no worries, would you prefer trying to solve this or could another contributor take over your PR, as long as they keep you as a co-author? Cheers!

Thank you @melissawm It would be perfect for me. Cheers!

QuLogic · 2023-06-06T20:39:21Z

Replaced by #26064, IIUC. Thank you for your initial work on this, @rbt94.

rbt94 · 2023-06-07T16:09:36Z

Thank you too for your work, sorry for the inconvenience for paused PR. Best, Robert Il mar 6 giu 2023, 22:39 Elliott Sales de Andrade ***@***.***> ha scritto:

…

Replaced by #26064 <#26064>, IIUC. Thank you for your initial work on this, @rbt94 <https://github.com/rbt94>. — Reply to this email directly, view it on GitHub <#25248 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AVDSMTKEIG3Q4YHTGQDE5KDXJ6IQLANCNFSM6AAAAAAVAGT6GU> . You are receiving this because you were mentioned.Message ID: ***@***.***>

added Ishikawa plot in response to issue matplotlib#25222 add organiz…

ed9b7b1

…ational charts to supported plots

github-actions bot reviewed Feb 18, 2023

View reviewed changes

rcomer added the Documentation label Feb 18, 2023

rcomer marked this pull request as draft February 18, 2023 18:01

rcomer linked an issue Feb 18, 2023 that may be closed by this pull request

[ENH]: add organizational charts to supported plots #25222

Closed

roberto.bodo added 2 commits February 19, 2023 11:12

fixing code style for flake8 first trial

963663d

second fixing style typo

2ef7f46

rbt94 marked this pull request as ready for review February 19, 2023 10:35

fix flake8 configuration

2018c75

jklymak reviewed Feb 19, 2023

View reviewed changes

tacaswell reviewed Feb 20, 2023

View reviewed changes

tacaswell added this to the v3.8.0 milestone Feb 20, 2023

scottshambaugh reviewed Feb 20, 2023

View reviewed changes

jklymak marked this pull request as draft February 20, 2023 21:58

jklymak added the status: needs revision label Feb 20, 2023

- revised comment style according to flake8 set rules

8147bf4

- improved example description docstring - removed __main__ call - debug print converted into logging.debug strings - removed sohw fig and save fig and related Path library - removed exception from flake8 conf file

scottshambaugh reviewed Feb 21, 2023

View reviewed changes

examples/specialty_plots/ishikawa.py Outdated Show resolved Hide resolved

fixed file docstring for title overlay sphinx error

c7b9111

Fix unmatched offsetText label color

e9ebc66

jklymak reviewed Feb 23, 2023

View reviewed changes

tacaswell and others added 18 commits March 2, 2023 12:34

Merge pull request matplotlib#25339 from QuLogic/test-anim-warning

f1bed13

Disable discarded animation warning on save

Pin sphinx themes more strictly

7754112

Merge pull request matplotlib#25369 from QuLogic/pin-sphinx

447c0c8

Pin sphinx themes more strictly

Tk: Fix size of spacers when changing display DPI

a3f4114

Fixes matplotlib#25365

Clean up Curve ArrowStyle docs

bf5bd76

By combining A/B parameters, to match the style of the CurveBracket, CurveFilled, etc. Also, tweak the example image so that it is not scaled down in the docs, and explicitly shows 0°.

Merge pull request matplotlib#25364 from QuLogic/wheel-license

981e1d1

BLD: Pre-download Qhull license to put in wheels

Merge pull request matplotlib#25371 from QuLogic/tk-spacer

a6acefe

Tk: Fix size of spacers when changing display DPI

Merge pull request matplotlib#25372 from QuLogic/curve-bracket

ed50a58

Clean up Curve ArrowStyle docs

"Inactive" workflow: bump operations-per-run [skip ci]

d9315e9

Merge pull request matplotlib#25378 from rcomer/inactive-more-ops

32b6ebb

"Inactive" workflow: bump operations-per-run

added Ishikawa plot in response to issue matplotlib#25222 add organiz…

42777af

…ational charts to supported plots

fixing code style for flake8 first trial

9cd719c

second fixing style typo

95fe3b1

- revised comment style according to flake8 set rules

9effc90

- improved example description docstring - removed __main__ call - debug print converted into logging.debug strings - removed sohw fig and save fig and related Path library - removed exception from flake8 conf file

fixed file docstring for title overlay sphinx error

0713507

Merge branch 'my-feature' of https://github.com/rbt94/matplotlib_ishi…

9ed2f7f

…kawa_example into my-feature

- fix examples folder

709653c

- change plt.figure with plt.subplots

69d76bf

- integrated hypot call instead sqrt formula - fix dict iteration - debug eliminated - alpha vars renaming - docstrings minor fixes

rcomer added the status: orphaned PR label Apr 21, 2023

saranti mentioned this pull request Jun 4, 2023

add ishikawa diagram to examples #26064

Merged

5 tasks

QuLogic closed this Jun 6, 2023

QuLogic added the status: superseded label Dec 8, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added Ishikawa plot in response to issue #25222 add organizational ch… #25248

added Ishikawa plot in response to issue #25222 add organizational ch… #25248

rbt94 commented Feb 18, 2023

github-actions bot left a comment

rcomer commented Feb 18, 2023

rbt94 commented Feb 19, 2023

jklymak Feb 19, 2023

tacaswell Feb 22, 2023

jklymak Feb 19, 2023

tacaswell Feb 20, 2023

jklymak Feb 19, 2023

tacaswell Feb 20, 2023

tacaswell commented Feb 20, 2023

scottshambaugh Feb 20, 2023

timhoffm Feb 23, 2023

rbt94 commented Feb 20, 2023 via email

rbt94 commented Feb 21, 2023

scottshambaugh commented Feb 21, 2023 •

edited

Loading

rbt94 commented Feb 22, 2023

tacaswell commented Feb 22, 2023

jklymak Feb 23, 2023

rbt94 commented Mar 4, 2023 •

edited

Loading

melissawm commented Mar 29, 2023

rbt94 commented Apr 8, 2023 via email

melissawm commented Apr 13, 2023

rbt94 commented Apr 15, 2023

QuLogic commented Jun 6, 2023

rbt94 commented Jun 7, 2023 via email

		'''


		def ishikawaplot(data, figsize=(20, 10), left_margin: float = 0.05, right_margin: float = 0.05, alpha_ps: float = 60.0,

		return None


		def ishikawaplot(data, figsize=(20, 10), left_margin: float = 0.05,

added Ishikawa plot in response to issue #25222 add organizational ch… #25248

added Ishikawa plot in response to issue #25222 add organizational ch… #25248

Conversation

rbt94 commented Feb 18, 2023

PR Summary

PR Checklist

github-actions bot left a comment

Choose a reason for hiding this comment

rcomer commented Feb 18, 2023

rbt94 commented Feb 19, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tacaswell commented Feb 20, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rbt94 commented Feb 20, 2023 via email

rbt94 commented Feb 21, 2023

scottshambaugh commented Feb 21, 2023 • edited Loading

rbt94 commented Feb 22, 2023

tacaswell commented Feb 22, 2023

Choose a reason for hiding this comment

rbt94 commented Mar 4, 2023 • edited Loading

melissawm commented Mar 29, 2023

rbt94 commented Apr 8, 2023 via email

melissawm commented Apr 13, 2023

rbt94 commented Apr 15, 2023

QuLogic commented Jun 6, 2023

rbt94 commented Jun 7, 2023 via email

scottshambaugh commented Feb 21, 2023 •

edited

Loading

rbt94 commented Mar 4, 2023 •

edited

Loading