Details for members with GitHub profile information and members of organisation

Adds additional profile information (such as a user's display name, company, and location) to a data frame created by [tidy_members], [tidy_owners] or [tidy_outside_collaborators].

The GitHub organisation endpoints do not return profile fields such as `name`, so this function retrieves them by calling the GitHub user profile endpoint (`GET /users/{username}`) for each login.

Usage

add_member_details(members, token = get_token())

Arguments

token

A GitHub installation access token or personal access token. Default uses `get_token()`

people

A tibble containing at least a `login` column

Value

tibble containing the original columns plus additional profile fields.

Details

GitHub's organisation-level APIs return only minimal user information. To obtain profile data, this function performs an additional API request for each user via the `/users/{username}` endpoint. The returned fields are merged back into the input data frame

The following fields are added: * `name` — the user's display name, * `company` — the user's listed organisation, * `location` — the user's location.

Missing fields are recorded as `NA`.

See also

* [combine_org_people()] * [tidy_members()] * [tidy_owners()] * [tidy_outside_collaborators()]

Examples

if (FALSE) { # \dontrun{
members <- get_members(org) |> tidy_members() |> add_member_details()
collaborators <- get_outside_collaborators(org) |>
tidy_outside_collaborators() |>
  add_member_details()
owners <- get_owners(org) |> tidy_owners() |> add_member_details()

} # }