Все функции пакета предназначены для работы с API v3 GitHub.
- Установка пакета rGitHub.
- Как получить токен для доступа к API GitHub.
- Как получить список своих репозиториев на GitHub с их основными параметрами.
- Как получить статистику по количеству показов и уникальных показов по репозиторию на GitHub по датам.
- Как получить статистику по количеству показов и уникальных показов по репозиторию на GitHub по рефераллам.
- Как получить статистику по количеству показов и уникальных показов по репозиторию на GitHub по страницам репозитория.
Установка пакета осуществляется из репозитория GitHub, для этого сначала требуется установить и подключить пакет devtools.
install.packages("devtools")
library(devtools)
После чего можно устанавливать пакет ryandexdirect.
install_github('selesnow/rGitHub')
library('rGitHub')
Для отправки запросов к API GitHub вам необходимо получить токен доступа, для этого достаточно перейти по этой ссылке, и нажать кнопку Generate New Token, далее требуется заполнить небольшую форму и сгенерировать токен.
Для того, что бы получить список репозиториев с их основными параметрами в пакете rGitHub есть функция ghGetRepositories.
- user - Ваш логин на GitHub
- token - Ваш токен доступа к API GitHub.
- id - ID репозитория
- name - Название репозиория
- full_name - Полное название репозитория, включает в себя логин владельца и название репозитория
- language - Программный язык репозитория
- owner_login - Логин владельца репозитория на GitHub
- owner_url - Ссылка на профиль владельца на GitHub
- private - Является ли репозиторий приватным
- html_url - URL репозитория
- description - Описание репозитория
- created_at - Дата создания репозитория
- updated_at - Дата последнего обновления репозитория
- stargazers_count - Количество звёзд в репозитории
- watchers_count - Количество подписчиков репозитория
- forks_count - Количество клонирований репозитория
- open_issues_count - Количество открытых тикетов в репозитории
git_repos <- ghGetRepositories(user = "selesnow", token = "abcde12345")
Для того, что бы получить количество показов и количество уникальных показов в разрезе дат за последние 14 дней есть функция ghGetView.
- user - Ваш логин на GitHub
- repos - Название репозитория
- token - Ваш токен доступа к API GitHub
- timestamp - Дата за которую приведена статистика
- views - Общее количество показов
- uniques - Коничество уникальных показов
github_stat <- ghGetView(user = "selesnow", repos = "ryandexdirect", token = "abcde12345")
Для того что бы получить статистику по реферралам в пакете rGitHub есть функция ghGetReferrers.
- user - Ваш логин на GitHub
- repos - Название репозитория
- token - Ваш токен доступа к API GitHub
- referrer - Название реферрала
- views - Общее количество показов
- uniques - Коничество уникальных показов
git_reffer <- ghGetReferrers(user = "selesnow", repos = "ryandexdirect", token = "abcde12345")
Что бы получить статистику показов в разрезе страниц репозитория необходимо воспользоваться функцией ghGetPopularPath.
- user - Ваш логин на GitHub
- repos - Название репозитория
- token - Ваш токен доступа к API GitHub
- path - URL адрес страницы репозитория
- title - Название страницы репозитория
- views - Общее количество показов
- uniques - Коничество уникальных показов
