view_users: View users in GitHub

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

Description

view_users() summarises users in a table with the properties as columns and a row for each user. view_user() returns a list of all properties for a single user. browse_user() opens the web page for the user in the default browser.

Usage

view_users(org, team, role = "all", n_max = 1000, ...)

view_user(user, ...)

browse_user(user, ...)

Arguments

org	(string, optional) The name of the organization.
team	(string, optional) The name of the team.
role	(string, optional) Filter the result by role. Can specify either "admin", "member" or "all". Default: "all".
n_max	(integer, optional) Maximum number to return. Default: 1000.
...	Parameters passed to gh_page() or gh_request().
user	(string) The login of the user.

Details

You can summarise all the users associated with either an organization or a team within an organization. If none of those are supplied the first n_max users of GitHub are returned.

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/orgs#list-organization-members

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

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

• https://docs.github.com/en/rest/reference/users#get-a-user

Value

view_users() returns a tibble of user properties. view_user() returns a list of properties for a single user. browse_user() opens the default browser on the user's page and returns the URL.

user Properties:

• id: The ID of the user.

• login: The login name of the user.

• name: The name of the user (only available in view_user()).

• email: The public email address of the user (only available in view_user()).

• blog: The blog address of the user (only available in view_user()).

• company: The company the user works for (only available in view_user()).

• location: The location of the user (only available in view_user()).

• hireable: Whether the user currently hireable (only available in view_user()).

• bio: The biography of the user (only available in view_user()).

• site_admin: Whether the user is an administrator.

• html_url: The GitHub page for the user.

Examples

## Not run: 

  # View users collaborating on a repository
  view_users(repo = "ChadGoymer/githapi")

  # View users in an organization
  view_users(org = "HairyCoos")

  # View users in a team within an organization
  view_users(org = "HairyCoos", team = "HeadCoos")

  # View the admins of an organization
  view_users(org = "HairyCoos", role = "admin")

  # View a single user
  view_user("ChadGoymer")

  # Browse a user's GitHub page
  browse_user("ChadGoymer")


## End(Not run)

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