change vignette setup for make cmd to render prebuilt vignette; update some man files

Author: sckott

CODE_OF_CONDUCT.md

@@ -10,7 +10,7 @@ Description: Work with 'GitHub' 'gists' from 'R' (e.g.,
     'gist' 'commits', and get rate limit information when 'authenticated'. Some
     requests require authentication and some do not. 'Gists' website: 
     <https://gist.github.com/>.
-Version: 0.5.1.91
+Version: 0.5.2.91
 Authors@R: c(
     person("Scott", "Chamberlain", role = c("aut", "cre"), 
         email = "[email protected]", 

DESCRIPTION

@@ -1,13 +1,10 @@
 PACKAGE := $(shell grep '^Package:' DESCRIPTION | sed -E 's/^Package:[[:space:]]+//')
 RSCRIPT = Rscript --no-init-file
 
-move:
-	cp inst/vign/gistr.md vignettes/
-	cp -rf inst/vign/img/* vignettes/img/
-
-rmd2md:
+vign:
 	cd vignettes;\
-	mv gistr.md gistr.Rmd
+	${RSCRIPT} -e "Sys.setenv(NOT_CRAN='true'); knitr::knit('gistr.Rmd.og', output = 'gistr.Rmd')";\
+	cd ..
 
 install: doc build
 	R CMD INSTALL . && rm *.tar.gz
@@ -29,3 +26,6 @@ check: build
 test:
 	${RSCRIPT} -e 'devtools::test()'
 
+readme:
+	${RSCRIPT} -e 'knitr::knit("README.Rmd")'
+

Makefile

@@ -21,14 +21,11 @@ knitr::opts_chunk$set(
 
 ## See also:
 
-* [rgithub](https://github.com/cscheid/rgithub) an R client for the Github API by Carlos Scheidegger
 * [git2r](https://github.com/ropensci/git2r) an R client for the libgit2 C library by Stefan Widgren
 * [gert](https://github.com/r-lib/gert) Simple git client for R by Jeroen Ooms
 * [gistfo](https://github.com/MilesMcBain/gistfo) for turning your untitled RStudio tabs into gists!
 
-## Quick start
-
-### Install
+## Install
 
 Stable version from CRAN
 
@@ -39,307 +36,18 @@ install.packages("gistr")
 Or dev version from GitHub.
 
 ```{r eval=FALSE}
-devtools::install_github("ropensci/gistr")
+remotes::install_github("ropensci/gistr")
 ```
 
 ```{r}
 library("gistr")
 ```
 
-### Authentication
-
-There are two ways to authorise gistr to work with your GitHub account:
-
-* Generate a personal access token (PAT) **with the gist scope selected** at [https://help.github.com/articles/creating-an-access-token-for-command-line-use](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.
-
-```{r eval=FALSE}
-gist_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):
-
-```{r eval=FALSE}
-file <- system.file("examples", "alm.md", package = "gistr")
-gists(what = "minepublic")[[1]] %>% # List my public gists, and index to get just the 1st one
-  add_files(file) %>% # Add a new file to that gist
-  update() # 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:
-
-```{r eval=FALSE}
-file <- system.file("examples", "alm.md", package = "gistr")
-g <- gists(what = "minepublic")[[1]]
-g <- add_files(g, file)
-update(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)
-
-```{r eval=FALSE}
-file <- system.file("examples", "alm.md", package = "gistr")
-update(add_files(gists(what = "minepublic")[[1]], file))
-```
-
-### Rate limit information
-
-```{r}
-rate_limit()
-```
-
-### List gists
-
-Limiting to a few results here to keep it brief
-
-```{r}
-gists(per_page = 2)
-```
-
-Since a certain date/time
-
-```{r}
-gists(since='2014-05-26T00:00:00Z', per_page = 2)
-```
-
-Request different types of gists, one of public, minepublic, mineall, or starred.
-
-```{r}
-gists('minepublic', per_page = 2)
-```
-
-
-### List a single commit
-
-```{r}
-gist(id = 'f1403260eb92f5dfa7e1')
-```
-
-### Create gist
-
-You can pass in files
-
-```{r}
-file <- system.file("examples", "stuff.md", package = "gistr")
-gist_create(file, description='a new cool gist', browse = 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.
-
-```{r eval=FALSE}
-gist_create(code={'
-x <- letters
-numbers <- runif(8)
-numbers
-
-[1] 0.3229318 0.5933054 0.7778408 0.3898947 0.1309717 0.7501378 0.3206379 0.3379005
-'})
-```
-
-```{r}
-gist_create(code={'
-x <- letters
-numbers <- runif(8)
-numbers
-
-[1] 0.3229318 0.5933054 0.7778408 0.3898947 0.1309717 0.7501378 0.3206379 0.3379005
-'}, browse=FALSE)
-```
-
-#### knit and create
-
-You can also knit an input file before posting as a gist:
-
-```{r eval=FALSE}
-file <- system.file("examples", "stuff.Rmd", package = "gistr")
-gist_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):
-
-```{r eval=FALSE}
-gist_create(code={'
-x <- letters
-(numbers <- 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
-
-```{r}
-file <- system.file("examples", "stuff.Rmd", package = "gistr")
-run(file, knitopts = list(quiet=TRUE)) %>% gist_create(browse = FALSE)
-```
-
-```{r echo=FALSE}
-gists('minepublic')[[1]] %>% delete
-```
-
-knit a code block (knitr code block notation missing, do add that in) (result not shown)
-
-```{r eval=FALSE}
-run({'
-x <- letters
-(numbers <- runif(8))
-'}) %>% gist_create
-```
-
-knit a file from a gist, has to get file first (result not shown)
-
-```{r eval=FALSE}
-gists('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
-
-```{r eval=FALSE}
-file <- system.file("examples", "plots_imgur.Rmd", package = "gistr")
-gist_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
-
-```{r eval=FALSE}
-file <- system.file("examples", "plots.Rmd", package = "gistr")
-gist_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
-
-```{r}
-gists()[[1]] %>% commits()
-```
-
-### Star a gist
-
-Star
-
-```{r eval = FALSE}
-gist('cbb0507082bb18ff7e4b') %>% star()
-#> <gist>cbb0507082bb18ff7e4b
-#>   URL: https://gist.github.com/cbb0507082bb18ff7e4b
-#>   Description: This is my technical interview cheat sheet.  Feel free to fork it or do whatever you want with it.  PLEASE let me know if there are any errors or if anything crucial is missing.  I will add more links soon.
-#>   Public: TRUE
-#>   Created/Edited: 2014-05-02T19:43:13Z / 2018-04-16T21:11:53Z
-#>   Files: The Technical Interview Cheat Sheet.md
-#>   Truncated?: FALSE
-```
-
-Unstar
-
-```{r eval = FALSE}
-gist('cbb0507082bb18ff7e4b') %>% unstar()
-#> <gist>cbb0507082bb18ff7e4b
-#>   URL: https://gist.github.com/cbb0507082bb18ff7e4b
-#>   Description: This is my technical interview cheat sheet.  Feel free to fork it or do whatever you want with it.  PLEASE let me know if there are any errors or if anything crucial is missing.  I will add more links soon.
-#>   Public: TRUE
-#>   Created/Edited: 2014-05-02T19:43:13Z / 2018-04-16T21:27:36Z
-#>   Files: The Technical Interview Cheat Sheet.md
-#>   Truncated?: FALSE
-```
-
-### Edit a gist
-
-Add files
-
-```{r}
-file <- system.file("examples", "alm.md", package = "gistr")
-gists(what = "minepublic")[[1]] %>%
-  add_files(file) %>%
-  update()
-```
-
-Delete files
-
-```{r}
-file <- system.file("examples", "alm.md", package = "gistr")
-gists(what = "minepublic")[[1]] %>%
-  delete_files(file) %>%
-  update()
-```
-
-### Open a gist in your default browser
-
-```{r eval=FALSE}
-gists()[[1]] %>% browse()
-```
-
-> Opens the gist in your default browser
-
-### Get embed script
-
-```{r}
-gists()[[1]] %>% embed()
-```
-
-### List forks
-
-Returns a list of `gist` objects, just like `gists()`
-
-```{r}
-gist(id='1642874') %>% forks(per_page=2)
-```
-
-### Fork a gist
-
-Returns a `gist` object
-
-```{r}
-g <- gists()
-(forked <- g[[ sample(seq_along(g), 1) ]] %>% fork())
-```
-
-```{r echo=FALSE}
-gist(forked$id) %>% delete()
-```
-
 ## Meta
 
 * Please [report any issues or bugs](https://github.com/ropensci/gistr/issues).
 * License: MIT
 * Get citation information for `gistr` in R doing `citation(package = 'gistr')`
-* Please note that this project is released with a [Contributor Code of Conduct][coc]. By participating in this project you agree to abide by its terms.
+* Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). By contributing to this project, you agree to abide by its terms.
 
 [![rofooter](https://ropensci.org/public_images/github_footer.png)](https://ropensci.org)
-
-[coc]: https://github.com/ropensci/gistr/blob/master/CODE_OF_CONDUCT.md