update_gist: Update a gist in GitHub

In ChadGoymer/githapi: User-friendly access to the GitHub API for R

Description

This function updates an existing gist in GitHub. You can specify add or update files by providing a named list and rename a file (see examples).

Usage

update_gist(gist, files, description, ...)

Arguments

gist	(string) The ID of the gist
files	(list, optional) The file contents with the list names as the filenames. Adding a filename element changes the filename (see examples).
description	(string, optional) A description for the gist.
...	Parameters passed to gh_request().

Details

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/gists#update-a-gist

Value

update_gist() returns a list of the gist's properties.

Gist Properties:

• id: The id for the gist

• description: The description of the gist

• files: A tibble of file properties:

  • filename: The name of the file

  • type: The type of file

  • content: The file content

  • size: The size of the file in bytes

  • truncated: Whether the file content has been truncated

• owner: The login if the gist's owner

• public: Whether the gist is public

• html_url: The address of the gist's web page.

• created_at: The time and date the gist was created.

• updated_at: The time and date the gist was last updated.

Examples

## Not run: 

  # Update a gist's description
  update_gist(
    gist        = "806dca6b09a39e7b6326a0c8137583e6",
    description = "An updated description"
  )

  # Update the contents of a file
  update_gist(files = list(hello_world.R = "cat(\"Hello World!\")"))

  # Update the contents of a file and the filename
  update_gist(
    files = list(
      hello_world.R = c("cat(\"Hello World!\")", filename = "new_filename.R")
    )
  )


## End(Not run)

ChadGoymer/githapi documentation built on Oct. 22, 2021, 10:56 a.m.