1% File src/library/utils/man/browseEnv.Rd
2% Part of the R package, https://www.R-project.org
3% Copyright 1995-2015 R Core Team
4% Distributed under GPL 2 or later
5
6\name{browseEnv}
7\alias{browseEnv}
8\alias{wsbrowser}
9\title{Browse Objects in Environment}
10\description{
11  The \code{browseEnv} function opens a browser with list of objects
12  currently in \code{sys.frame()} environment.
13}
14\usage{
15browseEnv(envir = .GlobalEnv, pattern,
16          excludepatt = "^last\\\\.warning",
17          html = .Platform$GUI != "AQUA",
18          expanded = TRUE, properties = NULL,
19          main = NULL, debugMe = FALSE)
20}
21\arguments{
22  \item{envir}{an \code{\link{environment}} the objects of which are to
23    be browsed.}
24  \item{pattern}{a \link{regular expression} for object subselection
25    is passed to the internal \code{\link{ls}()} call.}
26  \item{excludepatt}{a regular expression for \emph{dropping} objects
27    with matching names.}
28  \item{html}{is used to display the workspace
29    on a HTML page in your favorite browser.  The default except when
30    running from \command{R.app} on macOS.}
31  \item{expanded}{whether to show one level of recursion.  It can be useful
32    to switch it to \code{FALSE} if your workspace is large.  This
33    option is ignored if \code{html} is set to \code{FALSE}.}
34  \item{properties}{a named list of global properties (of the objects chosen)
35    to be showed in the browser;  when \code{NULL} (as per default),
36    user, date, and machine information is used.}
37  \item{main}{a title string to be used in the browser; when \code{NULL}
38    (as per default) a title is constructed.}
39  \item{debugMe}{logical switch; if true, some diagnostic output is produced.}
40}
41
42\details{
43  Very experimental code: displays a static HTML page on all platforms
44  except \command{R.app} on macOS.
45
46  Only allows one level of recursion into object structures.
47
48  It can be generalized.  See sources for details.
49  Most probably, this should rather work through using the \pkg{tkWidget}
50  package (from \url{https://www.bioconductor.org}).
51}
52\seealso{
53  \code{\link{str}}, \code{\link{ls}}.
54}
55\examples{
56if(interactive()) {
57   ## create some interesting objects :
58   ofa <- ordered(4:1)
59   ex1 <- expression(1+ 0:9)
60   ex3 <- expression(u, v, 1+ 0:9)
61   example(factor, echo = FALSE)
62   example(table, echo = FALSE)
63   example(ftable, echo = FALSE)
64   example(lm, echo = FALSE, ask = FALSE)
65   example(str, echo = FALSE)
66
67   ## and browse them:
68   browseEnv()
69
70   ## a (simple) function's environment:
71   af12 <- approxfun(1:2, 1:2, method = "const")
72   browseEnv(envir = environment(af12))
73 }
74}
75\keyword{interface}
76