Args                 package:svMisc                 R Documentation

_S_h_o_w _f_u_n_c_t_i_o_n _a_r_g_u_m_e_n_t_s _i_n _a _h_u_m_a_n-_r_e_a_d_a_b_l_e _w_a_y - _g_e_t _a _c_a_l_l _t_i_p

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

     'Args()' displays function arguments in a better way than 'args()'
     does. It is primarily intended for code tips in GUIs.

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

     Args(name, only.args = FALSE)
     CallTip(code, only.args = FALSE, location = FALSE)

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

    name: A string with the name of a function 

    code: A fraction of R code ending with the name of a function,
          eventually followed by '(' 

only.args: Do we return only arguments of the function ('arg1, arg2 =
          TRUE, ...'), or the full call, like ('myfun(arg1, arg2 =
          TRUE, ...)'). 

location: If 'TRUE' then the location (in which package the function
          resides) is appended to the calltip between square brackets 

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

     A string with the calling syntax of the function

_N_o_t_e:

     'Args()' is supposed to display S3 and S4 methods, and primitives
     adequately,... but this is not implemented yet in the current
     version!

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

     Philippe Grosjean <phgrosjean@sciviews.org>

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

             Args("ls")
             CallTip("myvar <- lm(")

