lmPerGene               package:GSEAlm               R Documentation

_F_i_t _l_i_n_e_a_r _m_o_d_e_l _f_o_r _e_a_c_h _g_e_n_e

_D_e_s_c_r_i_p_t_i_o_n:

     For each gene, 'lmPerGene' fits the same, user-specified linear
     model. It returns the estimates of the model parameters and their
     variances for each fitted model. The function uses matrix algebra
     so it is much faster than repeated calls to 'lm'.

_U_s_a_g_e:

     lmPerGene(eSet, formula, na.rm=TRUE)

_A_r_g_u_m_e_n_t_s:

    eSet: An 'ExpressionSet' object.

 formula: an object of class 'formula' (or one that can be coerced to
          that class), specifying only the right-hand side starting
          with the '~' symbol. The LHS is automatically set as the
          expression levels provided in  'eSet'. The names of all
          predictors must exist in the phenotypic data of 'eSet'.

   na.rm: 

     { Whether to remove missing observations. }

_D_e_t_a_i_l_s:

     This function efficiently computes the least squares fit of a
     linear regression to a set of gene expression values. We assume
     that there are 'G' genes, on 'n' samples, and that there are 'p'
     variables in the regression equation.  So the result is that 'G'
     different regressions are computed, and various summary statistics
     are returned.

     Since the independent variables are the same in each model
     fitting, instead of repeatedly fitting linear model for each gene,
     'lmPerGene' accelarates the fitting process by calculating the hat
     matrix 'X(X'X)^(-1)X'' first.  Then matrix multiplication, and
     'solve' are to compute estimates of the model parameters.

     Leaving the formula blank (the default) will calculate an 
     intercept-only model, useful for generic pattern and outlier
     identification.

_V_a_l_u_e:

     A list with components: 

    Hmat: The Hat matrix.

coefficients: A matrix of dimension 'p' by 'G' containing the estimated
          model parameters.

sigmaSqr: A vector of length $G$ containing the mean square error for
          that model, the sum of the residuals squared divided by 'n -
          p'.

coef.var: A matrix of dimension 'p' by 'G' containing the estimated
          variances for the model parameters, for each regression.

_A_u_t_h_o_r(_s):

     Robert Gentleman

_S_e_e _A_l_s_o:

     'getResidPerGene' to extract row-by-row residuals; 'gsealmPerm'
     for code that utilizes  'lmPerGene' for gene-set-enrichment
     analysis (GSEA); and  'CooksDPerGene' for diagnostic functions on
     an object produced by 'lmPerGene'.

_E_x_a_m_p_l_e_s:

     data(sample.ExpressionSet)
     layout(1)
     lm1 = lmPerGene(sample.ExpressionSet,~sex)
     qqnorm(lm1$coefficients[2,]/sqrt(lm1$coef.var[2,]),main="Sample Dataset: Sex Effect by Gene",ylab="Individual Gene t-statistic",xlab="Normal Quantile")
     abline(0,1,col=2)
     lm2 = lmPerGene(sample.ExpressionSet,~type+sex)
     qqnorm(lm2$coefficients[2,]/sqrt(lm2$coef.var[2,]),main="Sample Dataset: Case vs. Control Effect by Gene, Adjusted for Sex",ylab="Individual Gene t-statistic",xlab="Normal Quantile")
     abline(0,1,col=2)

