promptMethods            package:methods            R Documentation

_G_e_n_e_r_a_t_e _a _S_h_e_l_l _f_o_r _D_o_c_u_m_e_n_t_a_t_i_o_n _o_f _F_o_r_m_a_l _M_e_t_h_o_d_s

_D_e_s_c_r_i_p_t_i_o_n:

     Generates a shell of documentation for the methods of a generic
     function.

_U_s_a_g_e:

     promptMethods(f, filename, addTo = FALSE, inherited=FALSE, type = "methods")

_A_r_g_u_m_e_n_t_s:

       f: The name of the generic function whose methods are to be
          documented.

filename: Optional file on which to write the documentation shell. If
          `FALSE', the text is returned, presumably to be used in the
          documentation of the generic function itself (see `prompt'). 
          By default, this is the same as the coded topic name for
          these methods (currently `"NAME-methods.Rd"', where `NAME' is
          the function name, argument `f'). 

   addTo: Optionally, text to add to the shell.  This would typically
          be part of the contents of the documentation file for the
          generic function, if you want the generic and the methods
          documented together. 

inherited: Should inherited methods be included?  Default `FALSE'. 

    type: The documentation type to be declared in the output file.

_V_a_l_u_e:

     If `filename' is `FALSE', the text generated; otherwise, the name
     of the file written.

_A_u_t_h_o_r(_s):

     John Chambers

_R_e_f_e_r_e_n_c_e_s:

     The web page <URL: http://www.omegahat.org/RSMethods/index.html>
     is the primary documentation.

     The functions in this package emulate the facility for classes and
     methods described in Programming with Data (John M. Chambers,
     Springer, 1998).  See this book for further details and examples.

_S_e_e _A_l_s_o:

     `prompt' and `promptClass'

