delete_card: Delete a card in a GitHub project

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

Description

This function deletes a card in a GitHub project. Care should be taken as it will not be recoverable. Instead, you may way to archive the card with update_card().

Usage

delete_card(card, ...)

Arguments

card	(integer) The ID of the card.
...	Parameters passed to gh_request().

Details

You can delete a card associated with either a repository, user or organization, by supplying them as an input, as long as you have appropriate permissions.

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/projects#delete-a-project-card

Value

delete_card() returns a TRUE if successfully deleted.

Examples

## Not run: 

  # Delete a card
  delete_card(card = 123456)


## End(Not run)

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