README.md

In brian-bot/githubr: R Github Client

githubr

Making it easy to talk to GitHub from R

Installing githubr:

Currently, githubr is not available via CRAN, but can be installed directly from GitHub using the devtools package. A little bit meta, huh?

install.packages("devtools")
require(devtools)
install_github("brian-bot/githubr")

Overview

The purpose is to allow users to: Use GitHub as a version control system for analysis code in addition to enterprise software development Store code centrally for sourcing into an analysis environment * Allow easy sharing and forking of code that may be useful for others

Current status: For access to private repositories and/or to have an increased limit on the number of API calls, users should register a personal access token with the client via the setGithubToken function. Personal access tokens can be generated on your GitHub settings page. Once you have called setGithubToken, the token passed to this function is then used for all subsequent calls to GitHub API for the current R session. Currently staying away from downloading files -- sticking with meta-information and ability to directly source files * sourceRepoFile sources code into the global environment, but allows users to pass optional arguments as specified in the base::source() function

Quickstart Guide

## LOAD THE PACKAGE
require(githubr)

## USE TOKEN TO AUTHENTICATE FOR YOUR CURRENT SESSION
setGithubToken("myTokenFromGithub12345678")

#####
## ACCESSING META-INFORMATION ABOUT A GITHUB REPOSITORY
#####
## FOR HEAD OF MASTER BRANCH OF A GITHUB REPOSITORY
repoHead <- getRepo('brian-bot/githubr')

## OR HEAD OF A SPECIFIC BRANCH (dev)
repoBranch <- getRepo('brian-bot/githubr', ref='branch', refName='dev')

## OR A SPECIFIC COMMIT
repoCommit <- getRepo('brian-bot/githubr', ref='commit', refName='d3960fdbb8b1a4ef6990d90283d6ec474e424d5d')


#####
## VIEW THE SPECIFIC TIMEPOINT ON GITHUB WEBSITE
#####
view(repoHead)


#####
## SOURCING A FILE FROM A REPOSITORY
#####
sourceRepoFile(repoDev, "inst/misc/helloWorld.R")

brian-bot/githubr documentation built on June 21, 2021, 3:55 p.m.