visualiseHybridisations      package:arrayMagic      R Documentation

_M_i_c_r_o_a_r_r_a_y _i_n_t_e_n_s_i_t_y _d_a_t_a _a_r_e _v_i_s_u_a_l_i_s_e_d _w_i_t_h _r_e_s_p_e_c_t
_t_o _t_h_e_i_r _s_p_a_t_i_a_l _l_a_y_o_u_t

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

     Two colour microarray intensity data are visualised with respect
     to their spatial layout. Missing values ('NA') as well as minus
     infinity ('-Inf') etc. are not visualised. They appear to be
     white, i.e. in the colour of the background. '-Inf' might be a
     result of the (log-)transformation of the data; cf. the argument
     'transFunc'.

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

     visualiseHybridisations(arrayDataObject, exprSetRGObject, type="raw", hybridisations, slideNameColumn, numberOfSpots, nrOfBlocksPerRow=4, mappingColumns= list(Block="Block", Column="Column", Row="Row"), transFunc=log, savePath=".", plotOutput="pdf")

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

arrayDataObject: object of class 'arrayData'; required; default:
          missing

exprSetRGObject: object of class 'exprSetRG'; only required, if 'type =
          "normalised"' or 'type = "normalisedLogRatio"'; default:
          missing

    type: vector of character strings; required; default "raw"; valid
          strings are "raw", "rawLogRatio",
          "rawLogRatioBackgroundSubtracted", "normalised" or
          "normalisedLogRatio"

hybridisations: vector of integers; optional; default: missing, i.e.
          all microarray slides

slideNameColumn: character string specifying the column
          'getHybAttr(arrayDataObject)' which contains the names of the
          hybridisations; optional; default: missing

numberOfSpots: integer; optional; default: missing; but required if the
          values in 'arrayDataObject' do not cover the whole microarray
          slide, i.e. do not contain all spots; cf. 'spatialLayout'.

nrOfBlocksPerRow: integer; cf. 'spatialLayout'; required; default: 4

mappingColumns: list; required; the list elements named "Block",
          "Column", "Row" define the corresponding column names given
          in 'getSpotAttr(arrayDataObject)'; the "Block" element is
          optional, if missing a single block is assumed; default:
          'list(Block="Block", Column="Column", Row="Row")'; cf.
          'spatialLayout' 

transFunc: transformation function applied to the raw data, in
          particular in combination with 'type = "raw"' you may for
          example use 'log' or 'rank'; (note: 'type = "rawLogRatio"'
          and 'type = "rawLogRatioBackgroundSubtracted"' require log );
          required; default: log

savePath: character string; required; default: "."

plotOutput: character string; required; either "screen", "pdf" or
          "win.metafile"; default: "pdf"

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

     None, but a plot is generated.

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

     Andreas Buness <a.buness@dkfz.de>

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

     'spatialLayout', 'exprSetRG-class', 'arrayData-class'

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

             

