koplsScale               package:kopls               R Documentation

_M_a_t_r_i_x _s_c_a_l_i_n_g _f_u_n_c_t_i_o_n

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

     Function for mean-centering and scaling of a matrix.

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

     koplsScale(x, center = "mc", scale = "none")

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

       x: The matrix to be mean-centered and/or scaled.

  center: Mean-centering type: Either 'mc' for column-wise
          mean-centering or 'no' for no mean-centering.

   scale: Scaling type: 'uv' for scaling to unit variance, 'pareto' for
          Pareto scaling (sqrt(uv)) or 'no' for no scaling.

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

     A list with the following properties: 

       x: The scaled matrix.

meanVector: Vector with mean values (possibly) used in the scaling.

sdVector: Vector with standard deviation values (possibly) used in the
          scaling.

   scale: Scaling type: see 'link{koplsScale}' for details.

  center: Mean-centering type see 'link{koplsScale}' for details.

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

     Max Bylesjo and Mattias Rantalainen

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

     Rantalainen M, Bylesjo M, Cloarec O, Nicholson JK, Holmes E and
     Trygg J. *Kernel-based orthogonal projections to latent structures
     (K-OPLS)*, _J Chemometrics_ 2007; 21:376-385.
     doi:10.1002/cem.1071.

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

