GitHub
29 March, 2024
Preview
Contributions to a repository example:
Views of a GitHub Repository over time
## Warning: Removed 4 rows containing missing values or values outside the scale range
## (`geom_line()`).
Data information
Data information for github overall data:
num_forksshows the number of times this repo has been forked. NA means it has never been forked.num_contributorshow many people have contributed to this reponum_starshow many people have starred this repo?health_percentagewhat percentage of “good software health” items as described by GitHub does this repo have?
knitr::kable(github_overall)| repo_name | num_forks | num_contributors | total_contributions | num_stars | health_percentage |
|---|---|---|---|---|---|
| fhdsl/metricminer | NA | 4 | 434 | 1 | 62 |
| fhdsl/metricminer-dashboard | NA | 3 | 158 | 0 | 62 |
| jhudsl/OTTR_Template | 12 | 17 | 937 | 14 | 75 |
| jhudsl/OTTR_Template_Website | 1 | 7 | 245 | 0 | 37 |
Data information for github timecourse:
timestampshows the date the counts correspond tocount_clonestells the number of clones made on this day. NAs generally indicate no one cloned the repository that day.unique_clonestells how many people did these clones come from? NAs generally indicate no one cloned the repository that day.count_viewshow many views did the repo get on this day? NAs generally indicate no one viewed the repository that dateunique_viewshow many people were those views from? NAs generally indicate no one viewed the repository that date
knitr::kable(github_timecourse)| repo | timestamp | count_clones | uniques_clones | count_views | uniques_views |
|---|---|---|---|---|---|
| fhdsl/metricminer | 2024-03-18 | 18 | 7 | 19 | 2 |
| fhdsl/metricminer | 2024-03-21 | 7 | 3 | 29 | 6 |
| fhdsl/metricminer | 2024-03-23 | 1 | 1 | NA | NA |
| fhdsl/metricminer | 2024-03-28 | 1 | 1 | 5 | 3 |
| fhdsl/metricminer | 2024-03-29 | 1 | 1 | NA | NA |
| fhdsl/metricminer | 2024-03-19 | NA | NA | 1 | 1 |
| fhdsl/metricminer | 2024-03-22 | NA | NA | 8 | 3 |
| fhdsl/metricminer | 2024-03-25 | NA | NA | 2 | 2 |
| fhdsl/metricminer-dashboard | 2024-03-16 | 1 | 1 | NA | NA |
| fhdsl/metricminer-dashboard | 2024-03-17 | 11 | 4 | NA | NA |
| fhdsl/metricminer-dashboard | 2024-03-18 | 1 | 1 | 16 | 6 |
| fhdsl/metricminer-dashboard | 2024-03-21 | 1 | 1 | 11 | 2 |
| fhdsl/metricminer-dashboard | 2024-03-22 | 1 | 1 | 2 | 1 |
| fhdsl/metricminer-dashboard | 2024-03-24 | 12 | 5 | NA | NA |
| fhdsl/metricminer-dashboard | 2024-03-28 | 1 | 1 | NA | NA |
| fhdsl/metricminer-dashboard | 2024-03-15 | NA | NA | 1 | 1 |
| fhdsl/metricminer-dashboard | 2024-03-20 | NA | NA | 17 | 7 |
| fhdsl/metricminer-dashboard | 2024-03-23 | NA | NA | 1 | 1 |
| fhdsl/metricminer-dashboard | 2024-03-25 | NA | NA | 1 | 1 |
| jhudsl/OTTR_Template | 2024-03-15 | 1 | 1 | NA | NA |
| jhudsl/OTTR_Template | 2024-03-16 | 1 | 1 | 4 | 1 |
| jhudsl/OTTR_Template | 2024-03-17 | 3 | 1 | 18 | 1 |
| jhudsl/OTTR_Template | 2024-03-18 | 3 | 3 | 34 | 4 |
| jhudsl/OTTR_Template | 2024-03-20 | 1 | 1 | 73 | 3 |
| jhudsl/OTTR_Template | 2024-03-22 | 10 | 5 | 127 | 5 |
| jhudsl/OTTR_Template | 2024-03-23 | 4 | 2 | 6 | 5 |
| jhudsl/OTTR_Template | 2024-03-24 | 1 | 1 | 1 | 1 |
| jhudsl/OTTR_Template | 2024-03-25 | 16 | 5 | 96 | 6 |
| jhudsl/OTTR_Template | 2024-03-26 | 3 | 1 | NA | NA |
| jhudsl/OTTR_Template | 2024-03-28 | 2 | 2 | 9 | 2 |
| jhudsl/OTTR_Template | 2024-03-29 | 8 | 3 | 28 | 2 |
| jhudsl/OTTR_Template | 2024-03-19 | NA | NA | 2 | 1 |
| jhudsl/OTTR_Template | 2024-03-21 | NA | NA | 17 | 4 |
| jhudsl/OTTR_Template | 2024-03-27 | NA | NA | 13 | 3 |
| jhudsl/OTTR_Template_Website | 2024-03-18 | 1 | 1 | NA | NA |
| jhudsl/OTTR_Template_Website | 2024-03-20 | 2 | 2 | 16 | 2 |
| jhudsl/OTTR_Template_Website | 2024-03-21 | 4 | 1 | 12 | 3 |
| jhudsl/OTTR_Template_Website | 2024-03-22 | 12 | 4 | 76 | 5 |
| jhudsl/OTTR_Template_Website | 2024-03-25 | 14 | 5 | 3 | 1 |
| jhudsl/OTTR_Template_Website | 2024-03-28 | 1 | 1 | 6 | 1 |
| jhudsl/OTTR_Template_Website | 2024-03-19 | NA | NA | 2 | 1 |
| jhudsl/OTTR_Template_Website | 2024-03-23 | NA | NA | 1 | 1 |
| jhudsl/OTTR_Template_Website | 2024-03-27 | NA | NA | 3 | 1 |
Setting up GitHub
At this point you should already have your GitHub authorization set up for your metricminer dashboard by having followed the instructions above..
In the _config_automation.yml you will need to specify
items in the GitHub section.
###### GitHub ######
refresh-github: yes
github_repos: [ fhdsl/metricminer, fhdsl/metricminer.org ]
github_googlesheet:- In the
_config_automation.ymlfile, make sure thatrefresh-githubis set to “yes”. - In
github_reposof your_config_automation.yml, specify the names of the repositories you’d like to collect data from ingithub_repos. Make sure it includes theowner/repositorye.g.fhdsl/metricminernot justmetricminer. Commas need to separate the repositories. Delete the example repositories we put there. - Optionally, if you are saving data to
Google, specify a googlesheet ID in
github_googlesheetyou’d like the GitHub data to be saved to. This will only be relevant if you’ve setdata_desttogoogle.
Customizing GitHub Data
In order to customize the data you are downloading from GitHub you
can modify the refresh-scripts/refresh-github.R script in
your repository.
You can take a look at the metricminer
R package documentation for more details about the functions and
what is possible.
If you have a metric need that is not currently fulfilled by
metricminer or metricminer-dashboard we
encourage you to file a
GitHub issue with us and let us know about your new feature idea (or bug
report).