convertWellCoordinates       package:cellHTS2       R Documentation

_C_o_n_v_e_r_t_s _d_i_f_f_e_r_e_n_t _w_e_l_l _i_d_e_n_t_i_f_i_e_r_s

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

     Converts between different ways of specifying well coordinates. 
     For example, "B02"  <-> c("B", "02") <-> 26.

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

     convertWellCoordinates(x, pdim, type="384")

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

       x: either: a character vector with alphanumeric well identifiers
          (e.g. 'B03'); or an 'nx2' character matrix whose first column
          contains letters and whose second column contains numbers; or
          an integer vector with position identifiers for wells within
          a plate (e.g. 27).

    pdim: a vector of length 2 with names 'nrow' and 'ncol' giving the
          number of rows and columns in a plate. E.g. 'c(nrow=16,
          ncol=24)' for 384-well plates.

    type: an alternative way of specifying 'pdim'. Supported are the
          values "24" for 'c(nrow=4, ncol=6)', "96" for 'c(nrow= 8,
          ncol=12)' "384" for 'c(nrow=16, ncol=24)'.

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

     A list with elements: 'letnum', with the alphanumeric well
     identifiers; 'let.num', with the alphanumeric well identifiers
     giving as a pair c(LETTER, 2-digits); 'num', with the integer
     position of the well within a plate.

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

     Ligia Bras ligia@ebi.ac.uk and Wolfgang Huber huber@ebi.ac.uk

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

         pd <- c("nrow"=8L, "ncol"=12L) # 96-well plate
         w <- sample(prod(pd), 3L)
         wpos <- convertWellCoordinates(w, pd)
         wpos

