ghclass (version 0.2.0)

user: GitHub user related tools

Description

• user_exists - returns TRUE if the username(s) (or organization) exist on GitHub and FALSE otherwise. Note that GitHub considers organizations to be a type of user.

• user_repos - returns a (filtered) vector of repositories belonging to the user.

• user_type - returns a vector of the accounts' types.

Usage

user_exists(user)
user_repos(
  user,
  type = c("owner", "all", "public", "private", "member"),
  filter = NULL,
  exclude = FALSE,
  full_repo = TRUE
)
user_type(user)

Arguments

user

Character. GitHub username(s).

type

Character. Can be one of "all", "owner", "public", "private", "member".

filter

Character. Regular expression pattern for matching (or excluding) repositories.

exclude

Logical. Should entries matching the regular expression in filter be excluded or included?

full_repo

Logical. Should the full repository address be returned (e.g. owner/repo instead of just repo)?

Examples

# NOT RUN {
user_exists(c("rundel", "ghclass-test", "hopefullydoesnotexist"))

user_repos("rundel", type = "public", filter = "ghclass")

user_repos("ghclass-test")

org_repos("ghclass-test")

user_type(c("rundel", "ghclass-test"))
# }