browseEnv                package:base                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>) but the
     `tcltk' package is not yet available for the Carbon version for
     MacOS.

_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)
        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))
      }

