browseEnv               package:utils               R Documentation

_B_r_o_w_s_e _O_b_j_e_c_t_s _i_n _E_n_v_i_r_o_n_m_e_n_t

_D_e_s_c_r_i_p_t_i_o_n:

     The 'browseEnv' function opens a browser with list of objects
     currently in 'sys.frame()' environment.

_U_s_a_g_e:

     browseEnv(envir = .GlobalEnv, pattern,
               excludepatt = "^last\\.warning",
               html = .Platform$OS.type != "mac",
               expanded = TRUE, properties = NULL,
               main = NULL, debugMe = FALSE)

_A_r_g_u_m_e_n_t_s:

   envir: an 'environment' the objects of which are to be browsed.

 pattern: a regular expression for object subselection is passed to the
          internal 'ls()' call.

excludepatt: a regular expression for _dropping_ objects with matching
          names.

    html: is used on non Macintosh machines to display the workspace on
          a HTML page in your favorite browser.

expanded: whether to show one level of recursion.  It can be useful to
          switch it to 'FALSE' if your workspace is large.  This option
          is ignored if 'html' is set to 'FALSE'.

properties: a named list of global properties (of the objects chosen)
          to be showed in the browser;  when 'NULL' (as per default),
          user, date, and machine information is used.

    main: a title string to be used in the browser; when 'NULL' (as per
          default) a title is constructed.

 debugMe: logical switch; if true, some diagnostic output is produced.

_D_e_t_a_i_l_s:

     Very experimental code.  Only allows one level of recursion into
     object structures. The HTML version is not dynamic.

     It can be generalized.  See sources
     ('..../library/base/R/databrowser.R') for details.

     'wsbrowser()' is currently just an internally used function; its
     argument list will certainly change.

     Most probably, this should rather work through using the
     'tkWidget' package (from <URL: www.Bioconductor.org>).

_S_e_e _A_l_s_o:

     'str', 'ls'.

_E_x_a_m_p_l_e_s:

     if(interactive()) {
        ## create some interesting objects :
        ofa <- ordered(4:1)
        ex1 <- expression(1+ 0:9)
        ex3 <- expression(u,v, 1+ 0:9)
        example(factor, echo = FALSE)
        example(table, echo = FALSE)
        example(ftable, echo = FALSE)
        example(lm, echo = FALSE, ask = FALSE)
        example(str, echo = FALSE)

        ## and browse them:
        browseEnv()

        ## a (simple) function's environment:
        af12 <- approxfun(1:2, 1:2, method = "const")
        browseEnv(envir = environment(af12))
      }

