aigct.reporter

Attributes

VARIANT_EFFECT_SCORE_COLS

Classes

VEAnalysisReporter

Report analysis results

Module Contents

aigct.reporter.VARIANT_EFFECT_SCORE_COLS = ['SCORE_SOURCE', 'GENOME_ASSEMBLY', 'CHROMOSOME', 'POSITION', 'REFERENCE_NUCLEOTIDE',...

class aigct.reporter.VEAnalysisReporter

Report analysis results

_write_metric_dataframe(out, metric_df: pandas.DataFrame)

_write_summary(out, metrics: aigct.model.VEAnalysisResult)

write_summary(metrics: aigct.model.VEAnalysisResult, dir: str = None)

Generate a report summarizing the results of an analysis. It will be written either to the screen or to a file.

Parameters

resultsVEAnalysisResult

Object containing the results of an analysis.

dirstr, optional

Directory to place the report file. The file name will begin with variant_bm_summary and suffixed by a unique timestamp. If not specified will print to the screen.

write_calibration_summary(metrics: aigct.model.VEAnalysisCalibrationResult, dir: str = None)

Generate a report summarizing the results of a calibration analysis. It will be written either to the screen or to a file.

Parameters

resultsVEAnalysisCalibrationResult

Calibration result object returned by calling VEAnalyzer.compute_calibration_metrics.

dirstr, optional

Directory to place the report file. The file name will begin with variant_bm_calibration_summary and suffixed by a unique timestamp. If not specified will print to the screen.

_write_calibration_summary(out, metrics: aigct.model.VEAnalysisCalibrationResult)