Package org.monarchinitiative.lirical.core.analysis

Interface LiricalAnalysisRunner

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

LiricalAnalysisRunnerImpl

public interface LiricalAnalysisRunner
extends Closeable

The analysis runner runs LIRICAL analysis on provided analysis subject (AnalysisData). The analysis is parametrized by AnalysisOptions. The runner throws LiricalAnalysisException if the analysis cannot be run as dictated by the options.

Method Summary

Modifier and Type	Method	Description
AnalysisResults	run(AnalysisData analysisData, AnalysisOptions analysisOptions)	Run analysis parametrized by analysisOptions on analysisData.

Methods inherited from interface java.io.Closeable

close

Method Details

run

AnalysisResults run(AnalysisData analysisData,
 AnalysisOptions analysisOptions)
             throws LiricalAnalysisException

Run analysis parametrized by analysisOptions on analysisData.

Parameters:

analysisData - data representing the analysis subject.

analysisOptions - analysis parameters.

Returns:

a container with results for each evaluated disease

Throws:

LiricalAnalysisException - if the analysis cannot be run, e.g. due to missing resource, such as FunctionalVariantAnnotator for a combination of GenomeBuild and TranscriptDatabase