genescale             package:genefilter             R Documentation

_S_c_a_l_e_s _a _m_a_t_r_i_x _o_r _v_e_c_t_o_r.

_D_e_s_c_r_i_p_t_i_o_n:

     'genescale' returns a scaled version of the input matrix m by
     applying the following formula to each column of the matrix: {   
     y[i] = ( x[i] - min(x) ) / ( max(x) - min(x) ) }

_U_s_a_g_e:

     genescale(m, axis=2, method=c("Z", "R"), na.rm=TRUE)

_A_r_g_u_m_e_n_t_s:

       m: Input a matrix or a vector with numeric elements. 

    axis: An integer indicating which axis of 'm' to scale.

  method: Either "Z" or "R", indicating whether a Z scaling or a range
          scaling should be performed.

   na.rm: A boolean indicating whether 'NA''s should be removed.

_D_e_t_a_i_l_s:

     Either the rows or columns of 'm' are scaled. This is done either
     by subtracting the mean and dividing by the standard deviation
     ("Z") or by subtracing the minimum and dividing by the range.

_V_a_l_u_e:

     A scaled version of the input. If 'm' is a 'matrix' or a
     'dataframe' then the dimensions of the returned value agree with
     that of 'm', in both cases the returned value is a 'matrix'.

_A_u_t_h_o_r(_s):

     R. Gentleman

_S_e_e _A_l_s_o:

     'genefinder','scale'

_E_x_a_m_p_l_e_s:

       m <- matrix(1:12, 4, 3)
       genescale(m)