genPlotTitleCmd            package:rattle            R Documentation

_G_e_n_e_r_a_t_e _a _s_t_r_i_n_g _t_o _a_d_d _a _t_i_t_l_e _t_o _a _p_l_o_t

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

     Generate a string that is intended to be 'eval''d that will add a
     title and sub-title to a plot. The string is a call to 'title',
     supplying the given arguments, 'paste'd together, as the main
     title, and generating a sub-title that begins with `Rattle' and
     continues with the current date and time, and finishes with the
     current user's username. This is used internally in Rattle to
     adorn a plot with relevant information, but may be useful outside
     of Rattle.

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

     genPlotTitleCmd(..., vector=FALSE)

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

     ...: one or more strings that will be pasted together to form the
          main title.

  vector: whether to return a vector as the result.

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

     Graham.Williams@togaware.com

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

     Package home page: <URL: http://rattle.togaware.com>

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

     'eval', 'title', 'plotRisk'.

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

     ## generate some random plot
     plot(rnorm(100))

     ## generate the string representing the command to add titles
     tl <- genPlotTitleCmd("Sample Plot of", "No Particular Import")

     ## cause the string to be executed as an R command
     eval(parse(text=tl))

