args2XML              package:tkWidgets              R Documentation

_C_o_n_v_e_r_t_i_n_g _t_h_e _f_o_r_m_a_l _a_r_g_u_m_e_n_t_s _t_o _a _f_u_n_c_t_i_o_n _a_n_d _c_o_n_v_e_r_t_s _i_n_t_o
_a_n _X_M_L _f_o_r_m_a_t

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

     This function reads the formal arguments to a given function and
     converts the content into an XML format

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

     args2XML(fun, xml.name = "", full.names = NULL, priority = NULL)

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

     fun: 'fun' name of the function of interests

xml.name: 'xml.name' a character string for the name of the xml file
          holding the content of the formal arguments to the function

full.names: 'full.names' a vector of character string with full
          description of each of the formal arguments to the function.
          The order of apperance of each description much correspond to
          the oreder of their appeerance in the formal argument list

priority: 'priority' a vector of integers or character strings
          indicating the priority of the arguments.

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

     Priority values are currently used to determine whether the
     argument will appear on a widget that has entry boxes for
     modifying the values of the arguments. Users of args2XML may not
     have any concern of the priority values

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

     No value will be returned.

_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 Zhang

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

     'fileWizard'

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

     fullNames <- c("Full path names", "Pattern to match",
     "Visiable file names", "Include path")
     args2XML(list.files, "temp.xml", fullNames, c(1, 2, 2, 2)) 
     readLines("temp.xml")
     unlink("temp.xml")

