File: getName.environment.R

package info (click to toggle)
r-cran-r.oo 1.21.0-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 1,796 kB
  • sloc: sh: 18; makefile: 2
file content (64 lines) | stat: -rw-r--r-- 1,514 bytes parent folder | download
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
###########################################################################/**
# @class "environment"
# @RdocMethod getName
#
# @title "Gets the name of an environment"
#
# \description{
#  @get "title", e.g. \code{"R_GlobalEnv"} or \code{"0x01ddd060"}.
# }
#
# @synopsis
#
# \arguments{
#   \item{env}{An @environment.}
#   \item{...}{Not used.}
# }
#
# \value{
#   Returns a @character string.
# }
#
# \examples{
#   name <- getName(globalenv())
#   print(name)
#   stopifnot(identical(name, "R_GlobalEnv"))
#
#   getName(new.env())
# }
#
# @author
#
# \seealso{
#   \code{\link[base:environment]{environmentName}()}.
# }
#
# \keyword{programming}
#*/###########################################################################
setMethodS3("getName", "environment", function(env, ...) {
  # base::environmentName() was added to R v2.5.0
  if (exists("environmentName", mode="function")) {
    name <- environmentName(env);
  } else {
    name <- "";
  }

  if (name == "") {
    name <- capture.output(print.default(env));
    name <- name[1]; # Just in case
    name <- gsub("[<]*environment:[ ]*([^>]*)[>]", "\\1", name);
  }

  name;
})



############################################################################
# HISTORY:
# 2008-03-25
# o Added getName() for 'environment':s. It extends base::environmentName()
#   to return the "pointer" if not a name.  It is used by 
#   getInternalAddress() of Object in R.oo.
# o Created.
############################################################################