README.md

In nganlyle/534_project: Access to GitHub Events API

gitevents

The package of gitevents provides functions for read-only access to GitHub public events and repository events API. Information on the most recent 30 events are available. Functionality includes a function returning plots and lists providing basic information about public events and a function to create a "labbook stamp" showing events for a given repository and date.

Data Sources

This set of functions/package accesses data from:

• api.github.com
  • https://api.github.com
  • See documentation on the Github API https://developer.github.com/v3/

Installation

library(devtools)

install_github("nganlyle/534_project")
library(gitevents)

Examples

The get_events_plots function creates two bar plots for event type and payload size.

get_events_plots()

The get_events_lists function creates two lists of actors and repos.

get_events_lists()

The function create_repo_df assembles the list of lists of git hub events into a data frame for further processing.

create_repo_df('nganlyle', '534_project')

The get_repo_log function selects the event ID, event type, actor, message, and time of git events from the data frame created by the create_repo_df function. It is limited to thirty previous events from the past nintey days.

get_repo_log('nganlyle', '534_project', '2020-02-02')

Meta

• Please report any issues or bugs.
• License: MIT
• Get citation information for gitevents in R doing citation(package = 'gitevents')
• • Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

nganlyle/534_project documentation built on Feb. 12, 2020, 3:11 a.m.