{"id":14068452,"url":"https://github.com/moodymudskipper/flow","last_synced_at":"2025-04-04T07:08:47.725Z","repository":{"id":41998831,"uuid":"215244277","full_name":"moodymudskipper/flow","owner":"moodymudskipper","description":"View and Browse Code Using Flow Diagrams","archived":false,"fork":false,"pushed_at":"2024-01-13T01:32:19.000Z","size":26552,"stargazers_count":389,"open_issues_count":55,"forks_count":26,"subscribers_count":16,"default_branch":"master","last_synced_at":"2024-04-25T11:03:31.555Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://moodymudskipper.github.io/flow/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/moodymudskipper.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-15T08:15:50.000Z","updated_at":"2024-06-10T11:33:03.514Z","dependencies_parsed_at":"2023-02-09T09:32:06.204Z","dependency_job_id":"ecc0095e-f639-43a3-853e-10e9a7000a3f","html_url":"https://github.com/moodymudskipper/flow","commit_stats":{"total_commits":456,"total_committers":10,"mean_commits":45.6,"dds":0.0942982456140351,"last_synced_commit":"7a243fad7d860b12b9c391eec941ea3c5f1e33e3"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moodymudskipper%2Fflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moodymudskipper%2Fflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moodymudskipper%2Fflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moodymudskipper%2Fflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/moodymudskipper","download_url":"https://codeload.github.com/moodymudskipper/flow/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247135144,"owners_count":20889421,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-13T07:06:11.057Z","updated_at":"2025-04-04T07:08:47.709Z","avatar_url":"https://github.com/moodymudskipper.png","language":"R","funding_links":[],"categories":["R","Developer Tools"],"sub_categories":["Debugging"],"readme":"---\noutput: github_document\n---\n\n\u003c!-- badges: start --\u003e\n[![R-CMD-check](https://github.com/moodymudskipper/flow/workflows/R-CMD-check/badge.svg)](https://github.com/moodymudskipper/flow/actions)\n\u003c!-- badges: end --\u003e\n\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n\n# flow \u003cimg src='man/figures/logo.png' align=\"right\" height=\"139\" /\u003e\n\n*{flow}* provides tools to visualize as flow diagrams the logic of functions, \nexpressions or scripts and ease debugging.\n\nUse cases are : \n\n* Deciphering other people's code\n* Getting more comfortable with our own code by easing a visual understanding of its structure\n* Documentation\n* Debugging\n* Inspect unit test results\n* Providing a higher level view of an algorithm to collaborators\n* Education\n\n## Installation\n\nInstall from CRAN with:\n\n``` r\ninstall.packages(\"flow\")\n```\n\nOr install development version from github:\n\n``` r\nremotes::install_github(\"moodymudskipper/flow\")\n```\n## Example\n\n```{r, eval=TRUE}\nlibrary(flow)\n```\n\nUsing default nomnoml engine\n\n```{r, eval=FALSE}\nflow_view(rle)\n```\n\n![nomnoml](man/figures/README_nomnoml.png)\n\nUsing plantuml engine (make sure the [{plantuml}](https://github.com/rkrug/plantuml) package is installed).\n\n```{r, eval=FALSE}\nflow_view(rle, engine = \"plantuml\")\n```\n\n![plantuml](man/figures/README_plantuml.png)\n\n## Additional functions\n\n* `flow_run()` to display not only the diagram, but the logical path taken by a specific call\n* `flow_compare_runs()` display the logical path of 2 calls to see where they diverge\n* `flow_debug()`/`flow_undebug()` to use basically use `flow_run()` on a function wherever it's called\n* `flow_view_vars()` to display the dependencies between variables in a function\n* `flow_view_deps()` to display recursively all the functions that your function calls\n* `flow_view_uses()` to display recursively all the functions that call your function\n* `flow_view_shiny()` to display the modular structure of your shiny app\n* `flow_view_source_calls()` to display dependency tree of scripts sourcing each other\n* `flow_doc()` to build a package's documentation using flow diagrams\n* `flow_test()` to show what happens in your unit tests\n* `flow_embed()` to embed diagrams in your documentation.\n\nSee more in vignettes.\n\n## Notes\n\nMake sure to check the vignettes for a detailed breakdown of all features.\n\n\n*{flow}* is built on top of Javier Luraschi's *{nomnoml}* package, and \nRainer M Krug 's *{plantuml}* package, the latter only available from \n[github](https://github.com/rkrug/plantuml)\nat the moment.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoodymudskipper%2Fflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmoodymudskipper%2Fflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoodymudskipper%2Fflow/lists"}