objectBrowser           package:gtkWidgets           R Documentation

_V_i_e_w _t_h_e _O_b_j_e_c_t_s _i_n _t_h_e _W_o_r_k_s_p_a_c_e

_D_e_s_c_r_i_p_t_i_o_n:

     This widget allows uers to view and select objects from the
     workspace. When the 'End' button is pressed, the selected objects
     will be returned as a list.

_U_s_a_g_e:

     objectBrowser(env = .GlobalEnv, fun = noAuto, textToShow = "Select object(s)", nSelect = -1, title = "BioC Object Browser") 

_A_r_g_u_m_e_n_t_s:

     fun: function to test whether certain conditions are met by the
          objects.  Only objects that meet the conditions will be
          displayed.

textToShow: character with the message to be shown on the widget as an
          instruction.

 nSelect: integer indicating the number of objects to select. No
          limitation if 'nSelect = -1' as per default.

   title: 'title' a character string for the text that will appear in
          the title bar of the widget

     env: 'env' an environment object whose keys will be shown in a
          list box when 'objectBrowser' is invoked. The default is the
          global environment

_D_e_t_a_i_l_s:

     This function will return a list of lists with a "name" and "obj"
     pair for each object selected. The "name" will be the name of the
     object and "obj" will be the value of the object. If the object is
     a package, a description of the contents of the package will be
     the value. If the selected object is a function, a text string of
     the original code will be the value. A function can be passed to
     impose a filtering mechanisms on the objects to be displayed. See
     function isCharacter for an example of writing a filtering
     function for objectBrowser.

     The buttons and their expected behavior are

     '_U_p' Moves one level up along the search list and displays the
          content in the box for object names on the left of the
          widget.

     '_S_e_l_e_c_t >>' When objects in the box for object names have been
          highlighted by clicking or clicking/dragging, this button
          will display the highlighted object names in the box for
          selected objects on the right.

     '_R_e_s_e_t' Moves back to '.GlobalEnv' which is the default starting
          point of the system.

     '<< _R_e_m_o_v_e' When object names in the box for selected objects have
          been highlighted by clicking or clicking/dragging and this
          button is pressed, the highlighted object names will be
          removed from the display.

     '_C_l_e_a_r' Removes all the object names from the box for selected
          objects.

     '_C_a_n_c_e_l' Exits the widget and returns 'NULL' when pressed.

     '_E_n_d' Returns a 'list' of lists with names of the objects in the
          box for selected objects and their corresponding values or
          'NULL' if nothing exists in the box.

_V_a_l_u_e:

     A 'list' of lists with a name and value pair for each object.

_N_o_t_e:

     This function is part of the Bioconductor project at Dana-Farber
     Cancer Institute to provide Bioinformatics functionalities through
     R.

_A_u_t_h_o_r(_s):

     Jianhua (John) Zhang

_E_x_a_m_p_l_e_s:

     ## The example here is only run interactively since it requires user
     ## interference which may cause problems if not available:
     if(interactive()) {

     # Call the function with the isCharacter function.
     r <- objectBrowser()
     str(r) # show what we've got
     }

