update_user: Update your user properties in GitHub

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

Description

This function updates your user properties in GitHub. You cannot update someone else's profile.

Usage

update_user(name, email, blog, company, location, hireable, bio, ...)

Arguments

name	(string, optional) The new name of the user.
email	(string, optional) The publicly visible email address of the user.
blog	(string, optional) The new blog URL of the user.
company	(string, optional) The new company of the user.
location	(string, optional) The new location of the user.
hireable	(boolean, optional) The new hiring availability of the user.
bio	(string, optional) The new short biography of the user.
...	Parameters passed to gh_request().

Details

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/users#update-the-authenticated-user

Value

update_user() returns a list of the new user properties.

User Properties:

• id: The ID of the user.

• login: The login name of the user.

• name: The name of the user.

• email: The public email address of the user.

• blog: The blog address of the user.

• company: The company the user works for.

• location: The location of the user.

• hireable: Whether the user currently hireable.

• bio: The biography of the user.

• type: The type of account.

• site_admin: Whether the user is an administrator.

• html_url: The GitHub page for the user.

Examples

## Not run: 

  # Update your name
  update_user(name = "Bob Smith")

  # Update your company
  update_user(company = "Acme")

  # Update your hireable status
  update_user(hireable = TRUE)


## End(Not run)

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