plotScreen              package:splots              R Documentation

_P_l_o_t _t_h_e _f_u_l_l _s_c_r_e_e_n _l_a_y_o_u_t

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

     'plot.screen' visualizes the whole screen in a single image
     preview. All wells are  plotted side by side, with data values
     shown in false colors.

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

         plotScreen(z, ncol = 6, dataSlot = NA, zrange = range(z, na.rm=TRUE), do.names = TRUE, do.legend = TRUE, nx = 24, ny = 16, fill = c("blue", "white", "red"), abris = "#333333", na.grayOpac = 1.0)

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

       z: A list of plate data. Each element provides data for a single
          plate. Elements  should be named if 'do.names' is TRUE. Data
          of each element can be an array or a  matrix of an arbitrary
          length, but only 'nx*ny' elements will be displayed to 
          constitute a plate-like format. Missing values will be
          displayed as gray.

    ncol: Number of columns (plates in one row) for the plot.

dataSlot: If elements of z are 'data.frame' or 'list' themselves,
          'dataSlot' specifies which element of those data values has
          to be plotted. A  character value.

  zrange: The range of data to plot. By default the full data range
          will be plotted.  Please beware that if 'dataSlot' is set,
          the default range can be totally wrong!

do.names: A boolean flag specifiying if plate captions should be
          plotted.

do.legend: A boolean flag specifying if a legend for false color values
          should be output.

      nx: An integer for the number of columns in a plate. Default 24
          for a 384-well plate.

      ny: An integer for the number of rows in a plate. Default 16 for
          a 384-well plate.

    fill: A character vector of colors to create a color ramp for the
          false color data representation. At least two colors must be
          specified. The default color correspond to blue for low
          values, white for the middle of the range and red for high
          values.

   abris: A character value for the color of the plate outline.

na.grayOpac: A double value for the opacity of gray for NA values.

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

     invisible(NULL)

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

     Copyright (c) 2005-2006 Oleg Sklyar : osklyar@ebi.ac.uk

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

     The initial idea of the function goes to Ligia Bras, the author of
     the 'cellHTS' package of Bioconductor.

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

         data(splots.screen)
         plotScreen(screen, 3)

