Retrieve GitHub information
An R6 class.
myRepo <- GitHubRepo$new("repo_name", "user_name") myRepo$get_stats() myRepo$get_branches() myRepo$get_issues() myRepo$get_labels() myRepo$get_milestones() myRepo$get_coc() myRepo$get_license() myRepo$get_pull_requests() myRepo$get_releases() myRepo$get_travis_status() myRepo$get_appveyor_status() myRepo$get_coverage()
GitHub user or organization name.
Name of the GitHub repository.
To create GitHubRepo
objects, you need to use GitHubRepo$new("repo_name", "user_name")
.
myRepo$get_stats()
will return the number of stars, forks and issues of the package.
myRepo$get_branches()
will return the name of the branches of the package.
myRepo$get_issues()
will return the list of open issues.
myRepo$get_labels()
will return the name and color labels used in issues filed in the package.
myRepo$get_milestones()
will return the details of milestones associated with the package.
myRepo$get_coc()
will return the code of conduct of the package.
myRepo$get_license()
will return license of the package.
myRepo$get_pull_requests()
will return all the open pull requests.
myRepo$get_releases()
will return all the releases of the package on GitHub.
myRepo$get_travis_status()
will return the build status of the package from Travis CI.
myRepo$get_appveyor_status()
will return the build status of the package from Appveyor.
myRepo$get_coverage()
will return code coverage of the package from Codecov.
# initialize object myRepo <- GitHubRepo$new("dplyr", "tidyverse") # get stats myRepo$get_stats()#> # A tibble: 1 x 3 #> stars issues forks #> <int> <int> <int> #> 1 2977 115 1087# get branches myRepo$get_branches()#> # A tibble: 16 x 1 #> branches #> <chr> #> 1 3451/filter_size_mismatch_error #> 2 3772-name_repair #> 3 3953_ghost_programming_vignette #> 4 4004_dollar_gets_grouped #> 5 4249/bind_rows_id #> 6 4277/quos_vars #> 7 4329-non_ascii #> 8 bug-tibble-vignette #> 9 dev-ggplot2 #> 10 f-travis-4 #> 11 gh-pages #> 12 master #> 13 r-0.7.6 #> 14 r-0.7.8 #> 15 r-0.7.9 #> 16 rc_0.8.0# get travis ci build status myRepo$get_travis_status()#> [1] "Failure"# get codecov code coverage myRepo$get_coverage()#> [1] "83.94805"