GitHub

Preview

Contributions to a repository example:

Views of a GitHub Repository over time

## Warning: Removed 5 rows containing missing values or values outside the scale range
## (`geom_line()`).

Data information

Data information for github overall data:

• num_forks shows the number of times this repo has been forked. NA means it has never been forked.
• num_contributors how many people have contributed to this repo
• num_stars how many people have starred this repo?
• health_percentage what percentage of “good software health” items as described by GitHub does this repo have?

knitr::kable(github_overall)

Data information for github timecourse:

• timestamp shows the date the counts correspond to
• count_clones tells the number of clones made on this day. NAs generally indicate no one cloned the repository that day.
• unique_clones tells how many people did these clones come from? NAs generally indicate no one cloned the repository that day.
• count_views how many views did the repo get on this day? NAs generally indicate no one viewed the repository that date
• unique_views how many people were those views from? NAs generally indicate no one viewed the repository that date

knitr::kable(github_timecourse)

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.yml file, make sure that refresh-github is set to “yes”.
• In github_repos of your _config_automation.yml, specify the names of the repositories you’d like to collect data from in github_repos. Make sure it includes the owner/repository e.g. fhdsl/metricminer not just metricminer. 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_googlesheet you’d like the GitHub data to be saved to. This will only be relevant if you’ve set data_dest to google.

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).