-
Notifications
You must be signed in to change notification settings - Fork 21
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 Deep Review contribution visualization #16
Conversation
Very cool. I have no major recommendations, and I see this is still a work in progress. The longer names are truncated on the figure. In the text or caption, I'd like to point out that this only one example of the types of contribution analysis we can do with the git log. These data tell an important story but don't capture issues, discussion, and review. We can also link to the deep review contribution page. Do you think the ~70k characters for me and Casey could reflect formatting changes that affected the diff of the entire manuscript? It may be a coincidence that our counts are so similar. A rough estimate in Word shows ~225k total characters in the manuscript. It isn't central to the points of the meta review, but annotating the timeline would make this even more informative. We could likely see the effects of particular issues that were open to rally contributors. The plateau in contributions follows the initial preprint. It's too bad that we fell behind on reviewing and merging pull requests because it would been nice to show how the bioRxiv posting actually attracted many new contributions. |
Here's the latest. It's a ridgeline plot of total words added up to a point in time. In parenthesis are the total words added per contributor. In 4be436a I attempted to remove the effect of relocation. The method is poor, but figuring out how to get accurate deltas has been a big timesink... I think we'll have to live with the current method until something better comes along. |
That looks great. I agree that it isn't worth your time to do a more fine-grained diff. The counts that I spot checked seem approximately correct. I noticed that we have some users who committed with multiple accounts. The figure shows Paul Agapow/Paul-Michael Agapow and Greg Way/Gregory Way. What do you think about adding a blank entry before and after me in the plot? That way none of the ridgelines would overlap. Could we accomplish that by inserting a null user with no contributions? I didn't check the plotting code to see if that is feasible or advisable. |
4bbefb3
to
0b384fe
Compare
How about now @agitter? |
Don't merge yet. I want to update the environment tomorrow. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great to me. Merge whenever you're ready.
This method aims to ignore lines that were relocated in the manuscript. It is not very advanced and probably doesn't work very well.
55c732b
to
e09a73d
Compare
@agitter I rebased and added the figure to the manuscript. Waiting on conda-forge/r-gdtools-feedstock#1 so we can export the image as SVG and use that for the manuscript embed. Perhaps review the caption for now (e09a73d), so this is ready to go when the conda-forge package update occurs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good, only one minor comment about the caption.
We could also reference this figure in the second to last paragraph.
After releasing the first version of our collaborative review in May 2017 [@doi:10.1101/142760], new authors have contributed text (Figure @fig:contrib)
I removed the new author count because I previously included unmerged pull requests.
Because our writing process, like others backed by the open git version control system (including Overleaf and Authorea), tracks the complete commit history, it also enables detailed retrospective contribution analysis. | ||
`TODO: confirm Overleaf and Authorea provide this type of git integration versus something more coarse` | ||
|
||
![ | ||
**Deep Review contributions by author over time.** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we've been using generic terms like "open review" and "review manuscript" and haven't referred to this as "Deep Review". We should introduce that term early on if you want to use it here.
e09a73d
to
6cade08
Compare
Installs r-gdtools=0.1.6 allowing installation of svglite via CRAN. Switches to local path to embed ridgeline plot SVG in manuscript.
This build is based on 9fab76c. This commit was created by the following Travis CI build and job: https://travis-ci.org/greenelab/meta-review/builds/291601869 https://travis-ci.org/greenelab/meta-review/jobs/291601870 [ci skip] The full commit message that triggered this build is copied below: Merge pull request #16: Deep Review figure Create Deep Review contribution visualization Refs #8
This build is based on 9fab76c. This commit was created by the following Travis CI build and job: https://travis-ci.org/greenelab/meta-review/builds/291601869 https://travis-ci.org/greenelab/meta-review/jobs/291601870 [ci skip] The full commit message that triggered this build is copied below: Merge pull request #16: Deep Review figure Create Deep Review contribution visualization Refs #8
This analysis computes contribution stats using git word-diff
Todo:
The current figure is based on https://doi.org/10.7554/eLife.26726.012, but I removed the squareroot transformation.