Github API Wrapper for R
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 27 commits ahead of UBC-MDS:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
R
man
tests
vignettes
.Rbuildignore
.gitignore
.travis.yml
CONDUCT.md
CONTRIBUTING.md
DESCRIPTION
Installations.R
LICENSE
NAMESPACE
README.md
codecov.yml
gitBusy.Rproj

README.md

gitBusy

Build Status codecov

gitBusy is a user-friendly and intuitive API wrapper for Github. The package allows users to efficiently retrieve information on organizations, users, and repositories from the Github website.

This project is part of the DSCI 525 Web and Cloud Computing Course for the Masters of Data Science program at The University of British Columbia.

Functions

  • organization_members(organization)

    • Returns a list of all the public users with their most commonly used languages in a dataframe and as a ggplot item.
  • org_repos(organization)

    • Function returns the the name, link and language for all the repositories in the organization.
  • repo_count(user)

    • Return the number of Pulic Repositories for an ID
  • user_preferences(user)

    • The function reads in the ID of a user and returns the a dataframe and ggplot item of the languages used by the user.

Installation / Uninstallation and Execution

To install this package, run the following command in the console for RStudio:

devtools::install_github("UBC-MDS/gitBusy")

Installing the package automatically installs the vignette.

To perform a clean removal of the packages, run

remove.packages('gitBusy')

Running Tests

To run the tests for this package, download and change directory to the repository. Then, in Rstudio console:

  1. Load the package functions into the environment using devtools::load_all()
  2. Run the tests using: devtools::test()

Vignette

For a comprehensive guide of gitBusy, you can read the vignette here

Contributors:

Abishek Murali @abimur-123

Sid Arora @sarora

Ivan Despot @Ivan-Despot

Avinash Prabhakaran @avinashkz