home *** CD-ROM | disk | FTP | other *** search
/ Big Green CD 8 / BGCD_8_Dev.iso / NEXTSTEP / UNIX / Educational / R-0.49-MI / R-0.49-I / help / base / prompt < prev    next >
Encoding:
Text File  |  1997-04-23  |  1.0 KB  |  37 lines
  1.     
  2.     _P_r_o_d_u_c_e _p_r_o_t_o_t_y_p_e _o_f _a _h_e_l_p()-_f_i_l_e
  3.     
  4.          prompt(object=, filename=)
  5.     
  6.          prompt.default(object,
  7.              filename = paste(name, ".man", sep = ""),
  8.              force.function = FALSE)
  9.     
  10.     _A_r_g_u_m_e_n_t_s:
  11.     
  12.           object : (typically) an R function
  13.     
  14.         filename : name of the output file
  15.     
  16.     force.function : treat object as function in any case
  17.     
  18.     _D_e_s_c_r_i_p_t_i_o_n:
  19.     
  20.          The main goal is to facilitate the constructing of
  21.          help() files for function documentation.  An ASCII file
  22.          filename is produced containing the proper function and
  23.          argument names of object. You have to edit it before
  24.          adding the documentation to the source tree, i.e.
  25.          (currently) to $RHOME/src/library/base/man/.
  26.     
  27.     _S_e_e _A_l_s_o:
  28.     
  29.          help and the documentation about writing help-files,
  30.          currently in the file $RHOME/mansrc/ABOUT.tex.
  31.     
  32.     _E_x_a_m_p_l_e_s:
  33.     
  34.          prompt(plot.default)
  35.          prompt(interactive, force.f=TRUE)
  36.     
  37.