File: getUsername.System.Rd

package info (click to toggle)
r-cran-r.utils 2.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,864 kB
  • sloc: sh: 18; makefile: 6
file content (44 lines) | stat: -rw-r--r-- 1,082 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  System.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{System$getUsername}
\alias{System$getUsername}
\alias{getUsername.System}
\alias{System.getUsername}
\alias{getUsername,System-method}

\title{Retrieves the name of the user running R}

\description{
 Retrieves the name of the user running R.
}

\usage{
## Static method (use this):
## System$getUsername(...)

## Don't use the below:
\method{getUsername}{System}(static, ...)
}

\value{
 Returns a \code{\link[base]{character}} string.
}

\details{
 First, this function checks the system environment variables \code{USER},
 and \code{USERNAME}.
 Second, it checks \code{Sys.info()["user"]} for user name details.
 Finally, it tries to query the system command \code{whoami}.
}

\seealso{
  \code{\link[R.utils:getHostname.System]{*getHostname}()}.
}
\keyword{internal}
\keyword{methods}