Interface ExpressionDataMatrixService

All Known Implementing Classes:

ExpressionDataMatrixServiceImpl

public interface ExpressionDataMatrixService

Tools for easily getting data matrices for analysis in a consistent way.

Author:

Paul

Method Summary

Modifier and Type	Method	Description
ExpressionDataDoubleMatrix	getFilteredMatrix(Collection<ProcessedExpressionDataVector> dataVectors, ArrayDesign arrayDesign, ExpressionExperimentFilterConfig filterConfig, boolean logTransform)
ExpressionDataDoubleMatrix	getFilteredMatrix(ExpressionExperiment ee, Collection<ProcessedExpressionDataVector> dataVectors, ExpressionExperimentFilterConfig filterConfig, boolean logTransform)	Provide a filtered expression data matrix.
ExpressionDataDoubleMatrix	getFilteredMatrix(ExpressionExperiment ee, Collection<ProcessedExpressionDataVector> dataVectors, ExpressionExperimentFilterConfig filterConfig, boolean logTransform, ExpressionExperimentFilterResult result)	Provide a filtered expression data matrix, reporting the per-stage attrition into a caller-supplied result.
ExpressionDataDoubleMatrix	getFilteredMatrix(ExpressionExperiment ee, ExpressionExperimentFilterConfig filterConfig)	Provide a filtered expression data matrix.
ExpressionDataDoubleMatrix	getProcessedExpressionDataMatrix(ExpressionExperiment ee)	Obtain the processed expression data matrix for a given experiment.
ExpressionDataDoubleMatrix	getProcessedExpressionDataMatrix(ExpressionExperiment ee, boolean thawAssays)
ExpressionDataDoubleMatrix	getProcessedExpressionDataMatrix(ExpressionExperiment ee, List<BioAssay> samples)
DoubleMatrix<Gene, ExpressionExperiment>	getRankMatrix(Collection<Gene> genes, Collection<ExpressionExperiment> ees, ProcessedExpressionDataVectorDao.RankMethod method)
ExpressionDataDoubleMatrix	getRawExpressionDataMatrix(ExpressionExperiment ee, List<BioAssay> samples, QuantitationType quantitationType)
ExpressionDataDoubleMatrix	getRawExpressionDataMatrix(ExpressionExperiment ee, QuantitationType quantitationType)	Obtain a raw expression data matrix for a given quantitation type

Method Details

getFilteredMatrix

ExpressionDataDoubleMatrix getFilteredMatrix(ExpressionExperiment ee,
 ExpressionExperimentFilterConfig filterConfig)
                                      throws FilteringException

Provide a filtered expression data matrix.

Parameters:

ee - the expression experiment.

filterConfig - the configuration.

Returns:

data matrix

Throws:

IllegalStateException - if there are no processed vectors

FilteringException

getFilteredMatrix

ExpressionDataDoubleMatrix getFilteredMatrix(ExpressionExperiment ee,
 Collection<ProcessedExpressionDataVector> dataVectors,
 ExpressionExperimentFilterConfig filterConfig,
 boolean logTransform)
                                      throws FilteringException

Provide a filtered expression data matrix.

Parameters:

ee - the expression experiment.

dataVectors - data vectors

filterConfig - the configuration.

logTransform - perform a log transformation on the data, this is ignored if the data is already on a log scale, the default is to return the data as is.

Returns:

data matrix

Throws:

FilteringException

getFilteredMatrix

ExpressionDataDoubleMatrix getFilteredMatrix(ExpressionExperiment ee,
 Collection<ProcessedExpressionDataVector> dataVectors,
 ExpressionExperimentFilterConfig filterConfig,
 boolean logTransform,
 ExpressionExperimentFilterResult result)
                                      throws FilteringException

Provide a filtered expression data matrix, reporting the per-stage attrition into a caller-supplied result.

The other overloads discard that result. Use this one when the attrition is wanted as well as the matrix -- the sample-correlation run records it on the audit event so a curator can see how many design elements each filter removed.

Parameters:

result - populated in place as each filter runs; untouched if filtering throws

Throws:

FilteringException

See Also:

• SampleCorrelationAnalysisPayload

getFilteredMatrix

ExpressionDataDoubleMatrix getFilteredMatrix(Collection<ProcessedExpressionDataVector> dataVectors,
 ArrayDesign arrayDesign,
 ExpressionExperimentFilterConfig filterConfig,
 boolean logTransform)
                                      throws FilteringException

Throws:

FilteringException

getProcessedExpressionDataMatrix

ExpressionDataDoubleMatrix getProcessedExpressionDataMatrix(ExpressionExperiment ee)

Obtain the processed expression data matrix for a given experiment.

getProcessedExpressionDataMatrix

ExpressionDataDoubleMatrix getProcessedExpressionDataMatrix(ExpressionExperiment ee,
 boolean thawAssays)

Parameters:

ee - the expression experiment.

thawAssays - whether to thaw the assays or not using Thaws.thawBioAssayDimension(BioAssayDimension)

Returns:

matrix of preferred data, with all missing values masked

getProcessedExpressionDataMatrix

ExpressionDataDoubleMatrix getProcessedExpressionDataMatrix(ExpressionExperiment ee,
 List<BioAssay> samples)

getRawExpressionDataMatrix

ExpressionDataDoubleMatrix getRawExpressionDataMatrix(ExpressionExperiment ee,
 QuantitationType quantitationType)

Obtain a raw expression data matrix for a given quantitation type

Throws:

IllegalStateException - if there are no raw vectors for the given quantitation type

getRawExpressionDataMatrix

ExpressionDataDoubleMatrix getRawExpressionDataMatrix(ExpressionExperiment ee,
 List<BioAssay> samples,
 QuantitationType quantitationType)

getRankMatrix

DoubleMatrix<Gene, ExpressionExperiment> getRankMatrix(Collection<Gene> genes,
 Collection<ExpressionExperiment> ees,
 ProcessedExpressionDataVectorDao.RankMethod method)