view_teams: View teams in an organization in GitHub

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

Description

view_teams() summarises teams in a table with the properties as columns and a row for each team. view_team() returns a list of all properties for a single team. browse_team() opens the web page for the team in the default browser.

Usage

view_teams(org, parent_team, n_max = 1000, ...)

view_team(team, org, ...)

browse_team(team, org, ...)

Arguments

org	(string, optional) The login of the organization.
parent_team	(integer or string, optional) The ID or name of a team. If supplied, all the child teams will be returned.
n_max	(integer, optional) Maximum number to return. Default: 1000.
...	Parameters passed to gh_page() or gh_request().
team	(integer or string) The ID or name of the team.

Details

You can summarise all the teams within an organisation, that are children to a parent team or, if neither are supplied, the teams the authenticated user is a member of.

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/teams#list-teams-for-the-authenticated-user

• https://docs.github.com/en/rest/reference/teams#list-teams

• https://docs.github.com/en/rest/reference/teams#list-child-teams

• https://docs.github.com/en/rest/reference/teams#get-a-team-by-name

Value

view_teams() returns a tibble of team properties. view_team() returns a list of properties for a single team. browse_team() opens the default browser on the team's page and returns the URL.

Team Properties:

• id: The ID of the team.

• name: The name of the team.

• slug: The team slug name.

• description: The description of the team.

• privacy: The privacy setting of the team - either "closed" or "secret".

• permission: The default repository permissions of the team.

• parent: The parent team.

• html_url: The URL of the team page in GitHub

The following are only returned using view_team():

• organization: The organization the team is associated with.

• members_count: The number of members.

• repos_count: The number of repositories the team has access to.

• created_at: When it was created.

• updated_at: When it was last updated.

Examples

## Not run: 

  # View teams authenticated user is a member of
  view_teams()

  # View teams in an organization
  view_teams("HairyCoos")

  # View a single team
  view_team("HeadCoos", "HairyCoos")

  # Browse a team's GitHub page
  browse_team("HeadCoos", "HairyCoos")


## End(Not run)

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