CD2H gitForager

ropensci/gistr

Name: gistr

Owner: rOpenSci

Description: Interact with GitHub gists from R

Created: 2014-05-21 12:41:23.0

Updated: 2017-12-27 13:07:59.0

Pushed: 2018-01-05 19:27:44.0

Homepage:

Size: 1168

Language: R

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

gistr

gistr is a light interface to GitHub's gists for R.

Quick start

Install

Stable version from CRAN

all.packages("gistr")

Or dev version from GitHub.

ools::install_github("ropensci/gistr")


ary("gistr")

Authentication

There are two ways to authorise gistr to work with your GitHub account:

Generate a personal access token (PAT) at https://help.github.com/articles/creating-an-access-token-for-command-line-use and record it in the GITHUB_PAT environment variable.
To test out this approach, execute this in R: Sys.setenv(GITHUB_PAT = "blahblahblah"), where “blahblahblah” is the PAT you got from GitHub. Then take gistr out for a test drive.
If that works, you will probably want to define the GITHUB_PAT environment variable in a file such as ~/.bash_profile or ~/.Renviron.
Interactively login into your GitHub account and authorise with OAuth.

Using the PAT is recommended.

Using the gist_auth() function you can authenticate separately first, or if you're not authenticated, this function will run internally with each function call. If you have a PAT, that will be used, if not, OAuth will be used.

_auth()

Workflow

In gistr you can use pipes, introduced perhaps first in R in the package magrittr, to pass outputs from one function to another. If you have used dplyr with pipes you can see the difference, and perhaps the utility, of this workflow over the traditional workflow in R. You can use a non-piping or a piping workflow with gistr. Examples below use a mix of both workflows. Here is an example of a piping workflow (with some explanation):

 <- system.file("examples", "alm.md", package = "gistr")
s(what = "minepublic")[[1]] %>% # List my public gists, and index to get just the 1st one
d_files(file) %>% # Add a new file to that gist
date() # update sends a PATCH command to the Gists API to add the file to your gist online

And a non-piping workflow that does the same exact thing:

 <- system.file("examples", "alm.md", package = "gistr")
 gists(what = "minepublic")[[1]]
 add_files(g, file)
te(g)

Or you could string them all together in one line (but it's rather difficult to follow what's going on because you have to read from the inside out)

 <- system.file("examples", "alm.md", package = "gistr")
te(add_files(gists(what = "minepublic")[[1]], file))

Rate limit information

_limit()
ate limit: 5000
emaining:  4938
esets in:  50 minutes

List gists

Limiting to a few results here to keep it brief

s(per_page = 2)
[1]]
gist>feae4fee7d1debd13e58
 URL: https://gist.github.com/feae4fee7d1debd13e58
 Description:
 Public: TRUE
 Created/Edited: 2015-07-03T00:18:51Z / 2015-07-03T00:18:52Z
 Files: gistfile1.txt
 Truncated?: FALSE

[2]]
gist>03430047a811520d880c
 URL: https://gist.github.com/03430047a811520d880c
 Description: Bootstrap Customizer Config
 Public: TRUE
 Created/Edited: 2015-07-03T00:18:30Z / 2015-07-03T00:18:30Z
 Files: config.json
 Truncated?: FALSE

Since a certain date/time

s(since='2014-05-26T00:00:00Z', per_page = 2)
[1]]
gist>feae4fee7d1debd13e58
 URL: https://gist.github.com/feae4fee7d1debd13e58
 Description:
 Public: TRUE
 Created/Edited: 2015-07-03T00:18:51Z / 2015-07-03T00:18:52Z
 Files: gistfile1.txt
 Truncated?: FALSE

[2]]
gist>03430047a811520d880c
 URL: https://gist.github.com/03430047a811520d880c
 Description: Bootstrap Customizer Config
 Public: TRUE
 Created/Edited: 2015-07-03T00:18:30Z / 2015-07-03T00:18:30Z
 Files: config.json
 Truncated?: FALSE

Request different types of gists, one of public, minepublic, mineall, or starred.

s('minepublic', per_page = 2)
[1]]
gist>b15270e69c09f3b87589
 URL: https://gist.github.com/b15270e69c09f3b87589
 Description: gist gist gist
 Public: TRUE
 Created/Edited: 2015-07-03T00:10:39Z / 2015-07-03T00:10:39Z
 Files: stuff.md
 Truncated?: FALSE

[2]]
gist>abbd1a5b0cfc633cfcfd
 URL: https://gist.github.com/abbd1a5b0cfc633cfcfd
 Description: gist gist gist
 Public: TRUE
 Created/Edited: 2015-07-03T00:09:34Z / 2015-07-03T00:09:35Z
 Files: stuff.md, zoo.json
 Truncated?: FALSE, FALSE

List a single commit

(id = 'f1403260eb92f5dfa7e1')
gist>f1403260eb92f5dfa7e1
 URL: https://gist.github.com/f1403260eb92f5dfa7e1
 Description: Querying bitly from R
 Public: TRUE
 Created/Edited: 2014-10-15T20:40:12Z / 2014-10-15T21:54:29Z
 Files: bitly_r.md
 Truncated?: FALSE

Create gist

You can pass in files

 <- system.file("examples", "stuff.md", package = "gistr")
_create(file, description='a new cool gist', browse = FALSE)
gist>974fd41ff30de9814cc1
 URL: https://gist.github.com/974fd41ff30de9814cc1
 Description: a new cool gist
 Public: TRUE
 Created/Edited: 2015-07-03T00:19:18Z / 2015-07-03T00:19:18Z
 Files: stuff.md
 Truncated?: FALSE

Or, wrap gist_create() around some code in your R session/IDE, with just the function name, and a {' at the start and a }' at the end.

_create(code={'
 letters
ers <- runif(8)
ers

0.3229318 0.5933054 0.7778408 0.3898947 0.1309717 0.7501378 0.3206379 0.3379005


_create(code={'
 letters
ers <- runif(8)
ers

0.3229318 0.5933054 0.7778408 0.3898947 0.1309717 0.7501378 0.3206379 0.3379005
browse=FALSE)
gist>4fd5a913e911ad70098c
 URL: https://gist.github.com/4fd5a913e911ad70098c
 Description:
 Public: TRUE
 Created/Edited: 2015-07-03T00:19:18Z / 2015-07-03T00:19:18Z
 Files: code.R
 Truncated?: FALSE

knit and create

You can also knit an input file before posting as a gist:

 <- system.file("examples", "stuff.Rmd", package = "gistr")
_create(file, description='a new cool gist', knit=TRUE)
gist>4162b9c53479fbc298db
 URL: https://gist.github.com/4162b9c53479fbc298db
 Description: a new cool gist
 Public: TRUE
 Created/Edited: 2014-10-27T16:07:31Z / 2014-10-27T16:07:31Z
 Files: stuff.md

Or code blocks before (note that code blocks without knitr block demarcations will result in unexecuted code):

_create(code={'
 letters
bers <- runif(8))
knit=TRUE)
gist>ec45c396dee4aa492139
 URL: https://gist.github.com/ec45c396dee4aa492139
 Description:
 Public: TRUE
 Created/Edited: 2014-10-27T16:09:09Z / 2014-10-27T16:09:09Z
 Files: file81720d1ceff.md

knit code from file path, code block, or gist file

knit a local file

 <- system.file("examples", "stuff.Rmd", package = "gistr")
file, knitopts = list(quiet=TRUE)) %>% gist_create(browse = FALSE)
gist>a25bdafc43ee46a98783
 URL: https://gist.github.com/a25bdafc43ee46a98783
 Description:
 Public: TRUE
 Created/Edited: 2015-07-03T00:19:19Z / 2015-07-03T00:19:19Z
 Files: stuff.md
 Truncated?: FALSE

knit a code block (knitr code block notation missing, do add that in) (result not shown)

{'
 letters
bers <- runif(8))
%>% gist_create

knit a file from a gist, has to get file first (result not shown)

s('minepublic')[[1]] %>% run() %>% update()

working with images

The GitHub API doesn't let you upload binary files (e.g., images) via their HTTP API, which we use in gistr. There is a workaround.

If you are using .Rmd or .Rnw files, you can set imgur_inject = TRUE in gistr_create() so that imgur knit options are injected at the top of your file so that images will be uploaded to imgur. Alternatively, you can do this yourself, setting knit options to use imgur.

A file already using imgur

 <- system.file("examples", "plots_imgur.Rmd", package = "gistr")
_create(file, knit=TRUE)
gist>1a6e7f7d6ddb739fce0b
 URL: https://gist.github.com/1a6e7f7d6ddb739fce0b
 Description:
 Public: TRUE
 Created/Edited: 2015-03-19T00:20:48Z / 2015-03-19T00:20:48Z
 Files: plots_imgur.md

A file NOT already using imgur

 <- system.file("examples", "plots.Rmd", package = "gistr")
_create(file, knit=TRUE, imgur_inject = TRUE)
gist>ec9987ad245bbc668c72
 URL: https://gist.github.com/ec9987ad245bbc668c72
 Description:
 Public: TRUE
 Created/Edited: 2015-03-19T00:21:13Z / 2015-03-19T00:21:13Z
 Files: plots.md

List commits on a gist

s()[[1]] %>% commits()
[1]]
commit>
 Version: 1a418fb4968d550f15f75deb5df4d470f00c6663
 User: sckott
 Commited: 2015-07-03T00:19:18Z
 Commits [total, additions, deletions]: [5,5,0]

Star a gist

Star

('7ddb9810fc99c84c65ec') %>% star()
gist>7ddb9810fc99c84c65ec
 URL: https://gist.github.com/7ddb9810fc99c84c65ec
 Description:
 Public: TRUE
 Created/Edited: 2014-06-27T17:50:37Z / 2015-07-02T23:56:27Z
 Files: code.R, manifest.yml, rrt_manifest.yml
 Truncated?: FALSE, FALSE, FALSE

Unstar

('7ddb9810fc99c84c65ec') %>% unstar()
gist>7ddb9810fc99c84c65ec
 URL: https://gist.github.com/7ddb9810fc99c84c65ec
 Description:
 Public: TRUE
 Created/Edited: 2014-06-27T17:50:37Z / 2015-07-02T23:56:27Z
 Files: code.R, manifest.yml, rrt_manifest.yml
 Truncated?: FALSE, FALSE, FALSE

Edit a gist

Add files

 <- system.file("examples", "alm.md", package = "gistr")
s(what = "minepublic")[[1]] %>%
d_files(file) %>%
date()
gist>4fd5a913e911ad70098c
 URL: https://gist.github.com/4fd5a913e911ad70098c
 Description:
 Public: TRUE
 Created/Edited: 2015-07-03T00:19:18Z / 2015-07-03T00:19:21Z
 Files: alm.md, code.R
 Truncated?: FALSE, FALSE

Delete files

 <- system.file("examples", "alm.md", package = "gistr")
s(what = "minepublic")[[1]] %>%
lete_files(file) %>%
date()
gist>4fd5a913e911ad70098c
 URL: https://gist.github.com/4fd5a913e911ad70098c
 Description:
 Public: TRUE
 Created/Edited: 2015-07-03T00:19:18Z / 2015-07-03T00:19:22Z
 Files: code.R
 Truncated?: FALSE

Open a gist in your default browser

s()[[1]] %>% browse()

Opens the gist in your default browser

Get embed script

s()[[1]] %>% embed()
1] "<script src=\"https://gist.github.com/sckott/4fd5a913e911ad70098c.js\"></script>"

List forks

Returns a list of gist objects, just like gists()

(id='1642874') %>% forks(per_page=2)
[1]]
gist>1642989
 URL: https://gist.github.com/1642989
 Description: Spline Transition
 Public: TRUE
 Created/Edited: 2012-01-19T21:45:20Z / 2015-06-11T19:40:48Z
 Files:
 Truncated?:

[2]]
gist>1643051
 URL: https://gist.github.com/1643051
 Description: Line Transition (Broken)
 Public: TRUE
 Created/Edited: 2012-01-19T21:51:30Z / 2015-06-11T19:40:48Z
 Files:
 Truncated?:

Fork a gist

Returns a gist object

 gists()
ked <- g[[ sample(seq_along(g), 1) ]] %>% fork())
gist>b022baf5c960e864addb
 URL: https://gist.github.com/b022baf5c960e864addb
 Description: Solution to level 1 in Untrusted: http://alex.nisnevich.com/untrusted/
 Public: TRUE
 Created/Edited: 2015-07-03T00:19:23Z / 2015-07-03T00:19:23Z
 Files: untrusted-lvl1-solution.js
 Truncated?: FALSE

Example use case

Working with the Mapzen Pelias geocoding API

The API is described at https://github.com/pelias/pelias, and is still in alpha they say. The steps: get data, make a gist. The data is returned from Mapzen as geojson, so all we have to do is literally push it up to GitHub gists and we're done b/c GitHub renders the map.

ary('httr')
 <- "http://pelias.mapzen.com/search"
<- GET(base, query = list(input = 'coffee shop', lat = 45.5, lon = -122.6))
 <- content(res, as = "text")
_create(code = json, filename = "pelias_test.geojson")
gist>017214637bcfeb198070
 URL: https://gist.github.com/017214637bcfeb198070
 Description:
 Public: TRUE
 Created/Edited: 2014-10-28T14:42:36Z / 2014-10-28T14:42:36Z
 Files: pelias_test.geojson

And here's that gist

pelias img