Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor changes and corrections to tutorials in the API #479

Merged
merged 7 commits into from
Oct 19, 2023

Conversation

thomasrobiglio
Copy link
Collaborator

*added missing focus tutorials #475
*added hyperedges in depth tutorial to API #456

I will also add a recipe for the coloring of hyperedges (as suggested in #478) + do minor changes correcting typos and imprecisions.

*added missing focus tutorials
*added hyperedges in depth tutorial
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@codecov
Copy link

codecov bot commented Oct 19, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (31b0fc8) 92.05% compared to head (123c28a) 92.05%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #479   +/-   ##
=======================================
  Coverage   92.05%   92.05%           
=======================================
  Files          60       60           
  Lines        4392     4392           
=======================================
  Hits         4043     4043           
  Misses        349      349           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@thomasrobiglio
Copy link
Collaborator Author

This should be ready now.

@maximelucas I made a small addition in the in depth tutorial about the edges, in the end when you show how to combine this with the nodes. I think you wanted to say that you can combine drawing nodes and edgesusing xgi.draw or plotting the nodes and edges separately.

@@ -57,20 +57,7 @@
"outputs": [
Copy link
Collaborator

@maximelucas maximelucas Oct 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

xgi.draw_hyperedges(), my mistake :)


Reply via ReviewNB

@@ -57,20 +57,7 @@
"outputs": [
Copy link
Collaborator

@maximelucas maximelucas Oct 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blues -> crest_r now


Reply via ReviewNB

@@ -57,20 +57,7 @@
"outputs": [
Copy link
Collaborator

@maximelucas maximelucas Oct 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done can be -> can be done hehe


Reply via ReviewNB

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was in Yoda mode

@maximelucas
Copy link
Collaborator

This is great, thanks so much Thomas.

I just left typo comments. Also I'd change "In Depth 2:" to "In depth -" for consistency with the others.
Screenshot 2023-10-19 at 14 23 16

@@ -11,7 +11,7 @@
},
Copy link
Collaborator

@maximelucas maximelucas Oct 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This option also allows to show an associated colorbar.


Reply via ReviewNB

@@ -11,7 +11,7 @@
},
Copy link
Collaborator

@maximelucas maximelucas Oct 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ax, collections = xgi.draw(H, pos=pos, dyad_color=link_color, edge_fc_cmap=cmap)

edge_collection = collections[-1]

plt.colorbar(edge_collection)


Reply via ReviewNB

@maximelucas
Copy link
Collaborator

Hero 🏇🏻

@thomasrobiglio thomasrobiglio merged commit 536f592 into xgi-org:main Oct 19, 2023
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants