heading               package:cwhprint               R Documentation

_W_r_i_t_e _a _l_i_n_e _o_f _t_e_x_t _w_i_t_h _u_n_d_e_r_l_i_n_i_n_g _a_n_d _b_l_a_n_k _l_i_n_e_s

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

     'heading' writes m blank lines, then text,  underline with
     length(text) copies of ch then write n blank lines comm can be
     used as comment character

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

       heading(text, comm = "", ch = "-", m = 1, n = 0)

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

    text: (one line) text string, if "": only m+n empty lines

    comm: optional comment character written at start of text and of
          underline

      ch: character used to underline text, if "": no underline

       m: number of empty lines written before text

       n: number of empty lines written after underlined text

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

     NULL

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

     Christian W. Hoffmann, christian.hoffmann@wsl.ch, \newline <URL:
     http://www.wsl.ch/staff/christian.hoffmann>

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

     #\#  "#|" means the left margin
     heading("Very compact","","=",0,1)
     #\#| 
     heading("","=")  # one blank line only
     #\#|
     heading("standard")
     #\#|
     #\#|standard
     #\#|--------
     heading("Just a line, not really a heading","","",0,0)
     #\#|Just a line, not really a heading

