textplot               package:gplots               R Documentation

_D_i_s_p_l_a_y _t_e_x_t _i_n_f_o_r_m_a_t_i_o_n _i_n _a _g_r_a_p_h_i_c_s _p_l_o_t.

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

     This function displays text output in a graphics window.  It is
     the equivalent of 'print' except that the output is displayed as a
     plot.

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

     textplot(object, halign="center", valign="center", cex, ...)
     ## Default S3 method:
     textplot(object, halign=c("center","left","right"),
              valign=c("center", "top", "bottom"), cex, ... )
     ## S3 method for class 'character':
     textplot(object, halign = c("center", "left", "right"),
              valign = c("center", "top", "bottom"), cex, fixed.width=TRUE,
              cspace=1, lspace=1, mar, ...)
     ## S3 method for class 'data.frame':
     textplot(object, halign = c("center", "left", "right"),
              valign = c("center", "top", "bottom"), cex, ...)
     ## S3 method for class 'matrix':
     textplot(object, halign = c("center", "left", "right"),
              valign = c("center", "top", "bottom"), cex, cmar = 2,
              rmar = 0.5, show.rownames = TRUE, show.colnames = TRUE,
              hadj = 1, vadj = 1, mar, ...)

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

  object: Object to be displayed.

  halign: Alignment in the x direction, one of "center", "left", or
          "right". 

  valign: Alignment in the y direction, one of "center", "top" , or
          "bottom"

     cex: Character size, see 'par' for details. If unset, the code
          will attempt to use the largest value which allows the entire
          object to be displayed.

fixed.width: Logical value indicating whether to emulate a fixed-width
          font by aligning characters in each row of text. This is
          usually necessary for text-formatted tables display properly.
          Defaults to 'TRUE'.

  cspace: Space between characters as a multiple of the width of the
          letter 'W'. This only applies when  'fixed.width==TRUE'. 

  lspace: Line spacing. This only applies when 'fixed.width==TRUE'.

     mar: Figure margins, see the documentation for 'par'.

rmar, cmar: Space between rows or columns, in fractions of the size of
          the letter 'M'.

show.rownames, show.colnames: Logical value indicating whether row or
          column names will be displayed.

hadj,vadj: Vertical and horizontal location of elements within matrix
          cells.  These have the same meaning as the 'adj' graphics
          paramter (see 'par').

     ...: Optional arguments passed to the text plotting command or
          specialied object methods

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

     A new plot is created and the object is displayed using the
     largest font that will fit on in the plotting region.  The
     'halign' and 'valign' parameters can be used to control the
     location of the string within the plotting region.

     For matrixes and vectors a specialized textplot function is
     available, which plots each of the cells individually, with column
     widths set according to the sizes of the column elements.  If
     present, row and column labels will be displayed in a bold font.

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

     The character scaling factor ('cex') used.

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

     Gregory R. Warnes gregory.r.warnes@pfizer.com

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

     'plot', 'text',  'capture.output'

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

     ## Not run: 
     ### simple examples
     # show R version information
     textplot(version)

     # show the alphabet as a single string
     textplot( paste(letters[1:26], collapse=" ") )

     # show the alphabet as a matrix
     textplot( matrix(letters[1:26], ncol=2))

     ### Make a nice 4 way display with two plots and two text summaries

     data(iris)
     par(mfrow=c(2,2))
     plot( Sepal.Length ~ Species, data=iris, border="blue", col="cyan",
           main="Boxplot of Sepal Length by Species" )
     plotmeans( Sepal.Length ~ Species, data=iris, barwidth=2, connect=FALSE,
                main="Means and 95% Confidence Intervals\nof Sepal Length by Species")

     info <- sapply( split(iris$Sepal.Length, iris$Species),
                     function(x) round(c(Mean=mean(x), SD=sd(x), N=gdata::nobs(x)),2) )

     textplot( info, valign="top"  )
     title("Sepal Length by Species")

     reg <- lm( Sepal.Length ~ Species, data=iris )
     textplot( capture.output(summary(reg)), valign="top")
     title("Regression of Sepal Length by Species")

     par(mfrow=c(1,1))

     ## End(Not run)

