genedmhtml              package:pinktoe              R Documentation

_G_e_n_e_r_a_t_e _H_T_M_L _a_n_d _p_e_r_l _f_i_l_e_s _t_o _e_n_a_b_l_e _t_r_e_e _t_r_a_v_e_r_s_a_l

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

     Called by pinktoe to traverse a tree and generate appropriate perl
     and HTML files that enable a CGI-enabled web-server to graphically
     traverse a tree.

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

     genedmhtml(treeobj, noderow, edmtextfn, edmtittext, cgibindir, htmldir, localdir, stateprintfn, requirelib, commonhtml)

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

 treeobj: A 'tree' or 'rpart' object to traverse 

 noderow: The row to begin at

edmtextfn: A function that can print out explanatory text given a
          variable name (see web help page and 'edm.text' example. 

edmtittext: Prints out a title string given a variable name 

cgibindir: A character string containing the directory where the perl
          files generated by pinktoe (with the extension '.pl') will be
          stored. (This should be the directory part of the URL of the
          cgi-bin directory). 

 htmldir: A character string containing the directory where the HTML
          files generated by pinktoe (with the extension '.htm') will
          be stored.  (This should be a pathname understood and able to
          be found by perl).  

localdir: A local location to store both the HTML and perl files
          immediately after they are generated 

stateprintfn: A user-supplied function that decides what to do when
          supplied with the 'yval' reached at the leaf of a tree. Some
          text can be output, or maybe a perl function call.  

requirelib: A library of perl functions that can be called by, e.g.
          'stateprintfn'. The library that this refers to should reside
          in the 'cgibin' directory. If no function calls are planned
          then it doesn't matter what argument is supplied.

commonhtml: A user-supplied function that prints out some HTML code.
          This is appended to every HTML web page.

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

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

     No deliberate return value.

_N_o_t_e:

     Not intended for general user use

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

     Guy P Nason

_R_e_f_e_r_e_n_c_e_s:

     <URL:
     http://www.stats.bris.ac.uk/~magpn/Research/Pinktoe/Welcome.html>

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

     'pinktoe'

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

     #
     #Not intended for general user use
     #

