https://github.com/r-lib/whoami

Username, full name, email address and GitHub username of the current user
https://github.com/r-lib/whoami

r

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/r-lib/whoami
• Owner: r-lib
• License: other
• Created: 2015-06-01T05:52:15.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2024-08-06T15:12:44.000Z (3 months ago)
• Last Synced: 2024-08-06T17:31:38.753Z (3 months ago)
• Topics: r
• Language: R
• Homepage: http://r-lib.github.io/whoami/
• Size: 1.93 MB
• Stars: 18
• Watchers: 3
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• jimsghstars - r-lib/whoami - Username, full name, email address and GitHub username of the current user (R)

README

        

```{r, setup, echo = FALSE, message = FALSE}

knitr::opts_chunk$set(

  comment = "#>",

  tidy = FALSE,

  error = FALSE)

```

# whoami

[![](https://www.r-pkg.org/badges/version/whoami)](https://www.r-pkg.org/pkg/whoami)

[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/whoami)](https://www.r-pkg.org/pkg/whoami)

[![R-CMD-check](https://github.com/r-lib/whoami/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/whoami/actions/workflows/R-CMD-check.yaml)

[![Codecov test coverage](https://codecov.io/gh/r-lib/whoami/branch/main/graph/badge.svg)](https://app.codecov.io/gh/r-lib/whoami?branch=main)

> 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](https://github.com/sindresorhus/username),

[sindresorhus/fullname](https://github.com/sindresorhus/fullname),

[sindresorhus/github-username](https://github.com/sindresorhus/github-username),

[paulirish/github-email](https://github.com/paulirish/github-email).

## Installation

Install the package from CRAN as usual:

```{r, eval = FALSE}

install.packages("whoami")

```

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

from GitHub:

```{r eval = FALSE}

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

```

## Usage

```{r}

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](http://r-lib.github.io/whoami/CODE_OF_CONDUCT.html).

By contributing to this project, you agree to abide by its terms.

## License

MIT © [Gábor Csárdi](https://github.com/gaborcsardi), [RStudio](https://github.com/rstudio)