Documentation: Add docs/contributors_graph.md #84
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also remove references to the local computer, which are of no interest to other people.
Describes what you can find in `bokeh/` and `panel/` subdirectories, and what you can find in `experiments/` subdirectory. Because this addition uses footnotes, enable "footnotes" extension for MkDocs: https://squidfunk.github.io/mkdocs-material/reference/footnotes/
For both apps, show how one can run them, and link to their demo on Heroku. While at it, remove Mermaid diagram - which got obsolete some time ago.
Currently only the general description, and subsection about "Commits over time" plot is included in this newly added documentation. This new documentation is available from MkDocs-generated documentation at GitHub Pages (will be available at https://ncusi.github.io/PatchScope/); there is also link to it in the project README.md. NOTE: There are few more screeshots in `docs/assets/screenshots/` than are curently used.
This subsection also explains how deletions and additions (of lines) are computed, using a simple example diff from the python-unidiff project.
This is the first type of plot that is not available in GitHub Insights. The description is pretty short, and does not describe what happens to the per-author plot, and the ordering in the authors grid.
Also add the section it is contained in, namely "Patch size and patch spreading (lines) over time". This metric comes from "Dissection of a Bug Dataset: Anatomy of 395 Patches from Defects4J" paper, as will the next one.
The defects4j_dissection.Listing_1.Closure-40.1x.png is the same as *.2x.* one, but this one is from 100% zoom, and the earlier is from 200% zoom.
This is the second metric (or submetric) taken from "Dissection of a Bug Dataset: Anatomy of 395 Patches from Defects4J" paper. TODO?: add some better example of a patch, and its metrics.
Also adds placeholder for "Line types distribution \[%] (area plot)" subsection. Note that generic information about 'line types [%]' plots should be moved to this sunsection, aftr it gets written. GitHub shows heatmap plots, but they have slightly different purpose.
…ors_graph.md
This documents current state of Sankey diagram (Sankey plot) support in
diffinsights_web, as of version 0.4.1. It is not complete, and not
finished. Among other things, there is no support for selecting period
of time ("From"), nor for selecting author (for per-author plots on authors
grid).
Currently the Sankey diagram is plotted using HoloViews (low-level
plotting library) with the interative Bokeh backend. There are however
other options, with their advantages and disadvantages:
- Plotly (interactive)
- Mermaid.js (with gradient, non-interactive), requires additional
support: awesome-panel/panel-mermaid or oruelle/md_mermaid
- pySankey (mentioned in python-graph-gallery.com)
- from PyPI: Irene-Sankey, mpl_sankey, Sugikey (interactive via Bokeh),
SankeyFlow, pSankey, pySankey2, Sankeyfy (for Plotly API, maybe as
inpiration), floWeaver + ipysankeywidget
…ibutors_graph.md Describe what Perspective pane is, and what it allows. Show 4 examples: - one of Datagrid plugin to display the tabular data - two of X/Y Scatter plugin, to examine correlation and interdependence - one of X Bar, with hierarchical groupby, and selection
This 'plot' type is here to make it easier to compare othe non-plot information among different authors. Back to showing split of contributions by line type. This is the last plot type in PatchScope 0.4.1, in Contributors Graph app left to be described.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This new documentation file is referenced from
README.mdand added to the generated documentation at https://ncusi.github.io/PatchScope/