createWF            package:widgetInvoke            R Documentation

_A _f_u_n_c_t_i_o_n _t_o _s_p_e_c_i_f_y _w_i_d_g_e_t _s_t_r_u_c_t_u_r_e _f_o_r _w_i_d_g_e_t_I_n_v_o_k_e

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

     This function will present a widget (currently using Gtk) that
     will allow the user (in this case, typically a package author or
     maintainer) to specify the structure of the function widgets used
     by 'widgetInvoke'.

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

     createWF(funName)

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

 funName: The name of the function to create a widget for

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

     The package that 'funName' is in must already be loaded via
     'library' for this function to work properly.

     This function will use RGtk to display a widget detailing the
     arguments of the specified function, and other information to be
     used for the 'widgetInvoke' function.  The widget presents a six
     column table, with the first column detailing each argument name.
     The arguments themselves are represented by the rows of the table.

     The 'Type' column specifies the type of the argument (e.g.
     'character', 'logical', etc).  If this field is blank, it is
     assumed that any type of value may be entered in by the
     'widgetInvoke' user.  A character vector can be entered to specify
     a set of possible values (e.g. '"mean", "median"') that the
     argument is allowed to take - to do this use comma separated,
     quoted strings.

     The 'Default' column is used to specify the default value of the
     argument, if any.  Leaving this field blank will imply that there
     is no default value, otherwise the value in this field must be of
     the type specified by 'type'.

     The 'Location' column describes where this argument will appear.
     The widget used by 'widgetInvoke' allows for notebook style
     paning, and this field will specify which pane the argument will
     appear on.  By default, all arguments appear on the "main" pane,
     but by specifying another string a new pane will be created.

     'WidgetType' allows the user to specify what sort of widget is
     used by 'widgetInvoke' for the entry of this argument. Currently,
     logical and vector types must use either 'Radio' or 'DropDown' and
     all other types must use 'TypeIn'.

     If the 'Required' check box is marked for an argument, that means
     that the argument must be filled in with a value by the
     'widgetInvoke' user.

     The 'Reset' button can be used to bring the entire table back to
     its original state.  Any changes the user has made will be
     reverted.

     The 'Check' button will check the validity of all the values
     stored in the table and report to the user if there are potential
     problems.

     The 'Preview' button will display a window that will be identical
     to what the 'widgetInvoke' user will see.  For this sub-window,
     the 'Evaluate' window will not actually evaluate the function, but
     simply close the window.

     The 'Save' button will save the information in the table to an XML
     file in the current directory, of the name 'FUN.xml', where 'FUN'
     is the name of the function.

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

     This function is used for its side effect, which is to output a
     file with the appropriate meta-data.  The default filename is
     'funName.xml' (where 'funName' is the same as the value specified
     by the parameter) and stored in the current working directory of
     the R session.  By using the 'Save As' button, this can be
     changed, and saved to any file the operator wishes.

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

     Jeff Gentry

_S_e_e _A_l_s_o:

     'widgetInvoke'

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

       if (interactive())
         createWF("testWIfun")

