view_columns: View columns within a GitHub project

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

Description

view_columns() summarises columns in a table with the properties as columns and a row for each column in the project. view_column() returns a list of all properties for a single column.

Usage

view_columns(project, repo, user, org, n_max = 1000, ...)

view_column(column, project, repo, user, org, ...)

Arguments

project	(integer or string) Either the project number or name.
repo	(string, optional) The repository specified in the format: owner/repo.
user	(string, optional) The login of the user.
org	(string, optional) The name of the organization.
n_max	(integer, optional) Maximum number to return. Default: 1000.
...	Parameters passed to gh_page() or gh_request().
column	(integer or string) The number or name of the column.

Details

You can summarise all the columns of a project associated with either a repository, user or organization, by supplying them as an input.

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/projects#list-project-columns

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

Value

view_columns() returns a tibble of column properties. view_column() returns a list of properties for a single column.

Column Properties:

• id: The ID of the column.

• name: The name given to the column.

• created_at: When it was created.

• updated_at: When it was last updated.

Examples

## Not run: 

  # View columns in a repository project
  view_columns(
    project = "Test columns",
    repo    = "ChadGoymer/githapi"
  )

  # View columns in a user's project
  view_columns(
    project = "Test columns",
    user    = "ChadGoymer"
  )

  # View columns in an organization's project
  view_column(
    project = "Test columns",
    org     = "HairyCoos"
  )

  # View a column in a repository project
  view_column(
    column  = "Test column",
    project = "Test columns",
    repo    = "ChadGoymer/githapi"
  )

  # View a column in a user's project
  view_column(
    column  = "Test column",
    project = "Test columns",
    user    = "ChadGoymer"
  )

  # View a column in an organization's project
  view_column(
    column  = "Test column",
    project = "Test columns",
    org     = "HairyCoos"
  )

  # View column by ID
  view_column(123456)


## End(Not run)

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