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

Create function use flowchart #46

Closed
athowes opened this issue May 17, 2024 · 4 comments · Fixed by #54
Closed

Create function use flowchart #46

athowes opened this issue May 17, 2024 · 4 comments · Fixed by #54
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@athowes
Copy link
Collaborator

athowes commented May 17, 2024

Use mermaid to show suggested path through use of functions in package:

  graph TD;
      A-->B;
      A-->C;
      B-->D;
      C-->D;
Loading

See example in https://github.com/CDCgov/Rt-without-renewal/tree/main/EpiAware#current-epiaware-model-diagram.

@athowes athowes added the documentation Improvements or additions to documentation label May 17, 2024
@athowes
Copy link
Collaborator Author

athowes commented May 20, 2024

can use this or similar to see functions call each other: https://cran.r-project.org/web/packages/CodeDepends/vignettes/intro.html

@seabbs
Copy link
Contributor

seabbs commented May 20, 2024

Note that what this won't do is build the flow diagram of how user facing functions should be used together (i.e it just does what calls what) which means it is a slightly different (but still useful) thing.

@athowes athowes self-assigned this May 22, 2024
@athowes
Copy link
Collaborator Author

athowes commented May 22, 2024

Here's the static analysis:

image

@seabbs
Copy link
Contributor

seabbs commented May 24, 2024

My TLDR from this is that most of the package is user facing with users expected to glue functions together (which is no bad thing IMO) and that most of the internal code is in data setup/preprocessing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants