ltbio.pipeline.reports#

Overview#

Classes#

PDFWriter

PDF Generation class

Reporter

Helper class that provides a standard way to create an ABC using

Contents#

class ltbio.pipeline.reports.PDFWriter#

Bases: fpdf.fpdf.FPDF

digraph inheritance10297ecd10 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "FPDF" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="PDF Generation class"]; "GraphicsStateMixin" -> "FPDF" [arrowsize=0.5,style="setlinewidth(0.5)"]; "GraphicsStateMixin" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Mixin class for managing a stack of graphics state variables."]; "PDFWriter" [URL="#ltbio.pipeline.reports.PDFWriter",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "FPDF" -> "PDFWriter" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

PDF Generation class

add_image_fullwidth_cell(filepath: str)#
add_image_grid_cell(filepaths: tuple[str])#
add_log_cell(text: str)#
add_section_cell(name: str)#
add_subsection_cell(text: str)#
add_text_cell(text: str)#
footer()#

Footer to be implemented in your own inherited class.

This is automatically called by add_page() and close() and should not be called directly by the user application. The default implementation performs nothing: you have to override this method in a subclass to implement your own rendering logic.

header()#

Header to be implemented in your own inherited class

This is automatically called by add_page() and should not be called directly by the user application. The default implementation performs nothing: you have to override this method in a subclass to implement your own rendering logic.

class ltbio.pipeline.reports.Reporter(writer: PDFWriter = None)#

Bases: abc.ABC

digraph inheritance5417a22883 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "ABC" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Helper class that provides a standard way to create an ABC using"]; "Reporter" [URL="#ltbio.pipeline.reports.Reporter",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "ABC" -> "Reporter" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

Helper class that provides a standard way to create an ABC using inheritance.

add_image_fullwidth(filepath: str)#
add_image_grid(filepaths: tuple[str])#
add_log_block(text: str)#
add_text_block(text: str)#
begin_section(name: str)#
begin_subsection(name: str)#
abstract body()#
output_report(title: str, filepath: str)#
set_title(title: str)#