autoText              package:ifultools              R Documentation

_A_u_t_o_m_a_t_i_c _t_e_x_t _p_l_a_c_e_m_e_n_t

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

     Automatically places a given character string in the sparsest
     location of the space spanned by the the x and y input
     coordinates.

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

     autoText(x, y=NULL, text.="", cex=1, col=1, nquadrant=5)

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

       x: if 'y' is not 'NULL', this argument is a numeric vector
          containing the abscissa (x-axis) values for the current plot.
          If 'y=NULL', this argument is taken as a numeric vector of
          ordinate (y-axis) values.

     cex: 'par' function character expansion value. Default: 1.

     col: 'par' function color value for the text. Default: 1.

nquadrant: an integer denoting the number of quadrants to partition the
          space spanned by x and y. For example, if 'nquadrants=3', the
          x-y space is partitioned into a 3x3 grid of equisized blocks.
          Default: 5.

   text.: a character string to place in the current plot. Default:
          '""'

       y: a numeric vector containing the ordinate (y-axis) values in
          the current plot. If 'NULL', the 'x' input argument is taken
          as the y-axis values while the x-axis values are extracted
          from 'x' via the 'positions' function. If there are no
          positions available, then the sequence '1:length(x)' is used
          as the x-axis positions. Default: 'NULL'.

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

     no output is returned.

_N_o_t_e:

     The defined text is positioned in the estimated sparsest region of
     the specified data set.

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

     'text', 'autoKey', 'sparsestQuadrant', 'mergeList'.

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

     ## quadratic 
     x <- seq(-5,5)
     y <- x^2
     plot(x,y,type="p")
     autoText(x, y, text="Some text in a parabola", cex=1.5)

