view_organizations: View organizations in GitHub

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

Description

view_organizations() summarises organizations in a table with the properties as columns and a row for each organization. view_organization() returns a list of all properties for a single organization. browse_organization() opens the web page for the organization in the default browser.

Usage

view_organizations(user, n_max = 1000, ...)

view_organization(org, ...)

browse_organization(org, ...)

Arguments

user	(string, optional) The login of the user. If NULL the authenticated user is used.
n_max	(integer, optional) Maximum number to return. Default: 1000.
...	Parameters passed to gh_page() or gh_request().
org	(string) The login of the organization.

Details

You can summarise all the organizations a user is a member of by specifying the user login, or the authenticated user if it is set to NULL. If a user is not supplied the first n_max organizations of GitHub are returned.

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/orgs#list-organizations-for-a-user

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

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

• https://docs.github.com/en/rest/reference/orgs#get-an-organization

Value

view_organizations() returns a tibble of organization properties. view_organization() returns a list of properties for a single organization. browse_organization() opens the default browser on the organization's page and returns the URL.

Organization Properties:

• id: The ID of the organization.

• login: The login name of the organization.

• description: The description of the organization.

The following are only returned using view_organization():

• name: The name of the organization.

• company: The name of the associated company.

• blog: The address for a blog.

• location: The geographical location.

• email: The email address for the organization.

• is_verified: Whether the organization has been verified.

• has_organization_projects: Whether the organization can have projects.

• has_repository_projects: Whether the organization's repositories can have projects.

• public_repos: The number of public repositories.

• public_gists: The number of public gists.

• html_url: The address for the organization's GitHub web page.

• created_at: When the organization was created.

• total_private_repos: The number of private repositories.

• owned_private_repos: The number of owned private repositories.

• private_gists: The number of private gists.

• disk_usage: The total disk usage for the organization.

• collaborators: The number of collaborators.

• billing_email: The email address for billing.

• plan_name: The name of the GitHub plan.

• plan_space: The total space allocated for the plan.

• plan_private_repos: The number of private repositories for the plan.

• default_repository_permission: The default access for new repositories.

• two_factor_requirement_enabled: Whether members require two-factor authentication.

• members_can_create_repositories: Whether members can create repositories.

Examples

## Not run: 

  # View organizations a user is a member of
  view_organizations(user = "ChadGoymer")

  # View organizations the authenticated user is a member of
  view_organizations(user = NULL)

  # View all organizations
  view_organizations()

  # View a single organization in more detail.
  view_organization("HairyCoos")

  # Browse a organization's GitHub page
  browse_organization("HairyCoos")


## End(Not run)

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