update: Update/modify a gist

In ropensci/gistr: Work with 'GitHub' 'Gists'

Update/modify a gist

Description

Update/modify a gist

Usage

update(gist, description = gist$description, ...)

Arguments

gist	A gist object or something coerceable to a gist
description	(character) Brief description of gist (optional)
...	Curl options passed on to verb-GET

Value

an object of class gist

Examples

## Not run: 
file1 <- system.file("examples", "alm.md", package = "gistr")
file2 <- system.file("examples", "zoo.json", package = "gistr")

# add new files
gists(what = "minepublic")[[3]] %>%
 add_files(file1, file2) %>%
 update()

# update existing files
### file name has to match to current name
gists(what = "minepublic")[[3]] %>%
 update_files(file1) %>%
 update()

# delete existing files
### again, file name has to match to current name
gists(what = "minepublic")[[3]] %>%
 delete_files(file1, file2) %>%
 update()

# rename existing files
# For some reason, this operation has to upload the content too
### first name is old file name with path (must match), and second is 
### new file name (w/o path)
## add first
gists(what = "minepublic")[[3]] %>%
 add_files(file1, file2) %>%
 update()
## then rename
gists(what = "minepublic")[[3]] %>%
 rename_files(list(file1, "newfile.md")) %>%
 update()
### you can pass in many renames
gists(what = "minepublic")[[3]] %>%
 rename_files(list(file1, "what.md"), list(file2, "new.json")) %>%
 update()

## End(Not run)

ropensci/gistr documentation built on Oct. 21, 2022, 2:14 p.m.