Username, full name, email address and GitHub username of the current user
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R
inst
man
tests
.Rbuildignore
.gitignore
.travis.yml
DESCRIPTION
LICENSE
Makefile
NAMESPACE
NEWS.md
README.Rmd
README.md
appveyor.yml

README.md

whoami

Linux Build Status Windows Build status CRAN RStudio mirror downloads Coverage Status

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

devtools::install_github("r-lib/whoami")

Usage

library(whoami)
username()
#> [1] "gaborcsardi"
fullname()
#> [1] "Gabor Csardi"
email_address()
#> [1] "csardi.gabor@gmail.com"
gh_username()
#> [1] "gaborcsardi"
whoami()
#>                 username                 fullname            email_address 
#>            "gaborcsardi"           "Gabor Csardi" "csardi.gabor@gmail.com" 
#>              gh_username 
#>            "gaborcsardi"

License

MIT © Gábor Csárdi