

prompt {base}                                R Documentation

_P_r_o_d_u_c_e _P_r_o_t_o_t_y_p_e _o_f _a_n _R _D_o_c_u_m_e_n_t_a_t_i_o_n _F_i_l_e

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

     Facilitate the constructing of files documenting R
     functions.

_U_s_a_g_e_:

     prompt(object, ...)

     prompt.default(object,
         filename = paste(name, ".Rd", sep = ""),
         force.function = FALSE)

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

  object: an R object, typically a function

filename: name of the output file

force.function: treat `object' as function in any case

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

     An ASCII file `filename' is produced containing the
     proper function and argument names of `object'.  You
     have to edit it before adding the documentation to the
     source tree, i.e., (currently) to
     `$R_HOME/src/library/base/man/'.

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

     `prompt.data.frame'.

     `help' and the chapter on ``Writing R documentation''
     in ``Writing R Extensions'' (see the `doc/manual' sub-
     directory of the R source tree).

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

     prompt(plot.default)
     prompt(interactive, force.f = TRUE)

