In gaborcsardi/whoami: Username, Full Name, Email Address, 'GitHub' Username of the Current User

knitr::opts_chunk$set(
  comment = "#>",
  tidy = FALSE,
  error = FALSE)

whoami

Username, full name, email address, GitHub username of the current user

For the username it tries the LOGNAME, USER, LNAME and USERNAME environment variables first. If these are all unset, or set to an empty string, then it tries running id on Unix-like systems and whoami on Windows.

For the full name of the user, it queries the system services and also tries the user's global git configuration. On Windows, it tries finding the global git configuration in Sys.getenv("USERPROFILE") if it doesn't find it in Sys.getenv("HOME") (often "Documents").

For the email address it uses the user's global git configuration. It tries finding the global git configuration in Sys.getenv("USERPROFILE") if it doesn't find it in Sys.getenv("HOME").

For the GitHub username it uses the GITHUB_USERNAME environment variable then it tries searching on GitHub for the user's email address.

Related JavaScript packages: sindresorhus/username, sindresorhus/fullname, sindresorhus/github-username, paulirish/github-email.

Installation

Install the package from CRAN as usual:

install.packages("whoami")

If you need the development version of this package, install it from GitHub:

pak::pak("r-lib/whoami")

Usage

library(whoami)
username()
fullname()
email_address()
gh_username()
whoami()

Code of Conduct

Please note that the whoami project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

License

MIT © Gábor Csárdi, RStudio

gaborcsardi/whoami documentation built on Nov. 3, 2023, 10:52 p.m.