descFun                package:svMisc                R Documentation

_G_e_t _t_e_x_t_u_a_l _h_e_l_p _o_n _f_u_n_c_t_i_o_n _o_r _f_u_n_c_t_i_o_n _a_r_g_u_m_e_n_t_s

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

     Textual help on functions or their arguments is extracted for text
     online help for a given function. By default, all arguments from
     the online help are returned for 'descArgs()'. If the file
     contains help for several function, one probably get also some
     irrelevant information. Use of 'args' to limit result is strongly
     encouraged.

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

     descFun(fun, package, lib.loc = NULL)
     descArgs(fun, args = NULL, package = NULL, lib.loc = NULL)

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

     fun: A character string with the name of a function (several
          functions accepted for 'descFun()' 

    args: Either 'NULL' (by default) to return the description of all
          arguments from the corresponding man page, or a character
          vector with names of the arguments to search for 

 package: A character string with the name of the package that contains
          'fun', or 'NULL' for searching in all loaded packages 

 lib.loc: A character vector of directory names of R libraries, or
          'NULL'. The default value of 'NULL' corresponds to all
          libraries currently known. If the default is used, the loaded
          packages are searched before the libraries. 

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

     A string with the description of the function or of its arguments.
     If the man page is not found, a vector of empty strings is
     returned. Empty strings are also returned for arguments that are
     not found in the man page.

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

     Philippe Grosjean <phgrosjean@sciviews.org>

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

     'CompletePlus'

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

     descFun("ls", "base")
     descFun("library", "base")
     descArgs("ls")
     descArgs("library", args = c("package", "pos"))

