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

use a mermaid flowchart #366

Merged
merged 7 commits into from
Dec 20, 2024
Merged

use a mermaid flowchart #366

merged 7 commits into from
Dec 20, 2024

Conversation

cjyetman
Copy link
Member

@cjyetman cjyetman commented Dec 17, 2024

builds a flowchart programmatically, which is easier to adapt and avoids adding a large static image

does add a dependency on DiagrammeR, but it's a Suggest not an Import


render as (further customization could be done, e.g. the function names could be made links and I think color/shape/size can be controlled)

Screenshot 2024-12-19 at 10 55 16

https://rmi-pacta.github.io/pacta.multi.loanbook/pr-preview/pr-366/articles/cookbook_running_the_analysis.html#structure-of-the-workflow

versus

Screenshot 2024-12-19 at 10 57 11

https://rmi-pacta.github.io/pacta.multi.loanbook/articles/cookbook_running_the_analysis.html#structure-of-the-workflow

Copy link

codecov bot commented Dec 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.05%. Comparing base (d1991e9) to head (f59471d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #366   +/-   ##
=======================================
  Coverage   80.05%   80.05%           
=======================================
  Files          29       29           
  Lines        3269     3269           
=======================================
  Hits         2617     2617           
  Misses        652      652           

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

Copy link

github-actions bot commented Dec 17, 2024

PR Preview Action v1.4.8
Preview removed because the pull request was closed.
2024-12-20 15:52 UTC

@cjyetman cjyetman marked this pull request as ready for review December 19, 2024 16:00
@cjyetman cjyetman requested a review from jacobvjk as a code owner December 19, 2024 16:01
@cjyetman cjyetman requested a review from jdhoffa December 19, 2024 16:01
Copy link
Member

@jacobvjk jacobvjk left a comment

Choose a reason for hiding this comment

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

Getting rid of a large png makes sense to me.
I would suggest we adjust the color to RMI color scheme and make this a bit larger though, I currently find this a bit delicate in size

@jacobvjk jacobvjk self-requested a review December 20, 2024 14:26
Copy link
Member

@jacobvjk jacobvjk left a comment

Choose a reason for hiding this comment

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

lgtm

@cjyetman cjyetman merged commit d1b3a22 into main Dec 20, 2024
12 checks passed
@cjyetman cjyetman deleted the mermaid-flowchart branch December 20, 2024 15:50
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