prometry.reportmaker.ReportMaker

class documentation

class ReportMaker:

Constructor: ReportMaker(title, outpath, cols, remove_strip, ...)

Class for a single atom

:data html_string: :data outpath: :data title:

Method	`__init__`	Initialises a GeoPdb with a biopython structure
Method	`addBoxComment`	Undocumented
Method	`addContours`	:param mtx: :param title: :param style: Can be filled, lines or both :param label: label the contours :param levels: can be number or cohosen list :param centres: sets 0 as the middle in the colours (use divergent colour map) :param palette: :param alpha: :param overlay: :return:...
Method	`addDataFrame`	Undocumented
Method	`addLineComment`	Undocumented
Method	`addPlot1d`	Undocumented
Method	`addPlot2d`	Undocumented
Method	`addPlotOnly`	Undocumented
Method	`addPlotPi`	Undocumented
Method	`addPoints2d`	Undocumented
Method	`addSeries`	Undocumented
Method	`addSeries_Not`	Undocumented
Method	`addSeries_Transposed`	Undocumented
Method	`addSurface`	Undocumented
Method	`changeColNumber`	Undocumented
Method	`getFooterString`	Undocumented
Method	`getHeaderString`	Undocumented
Method	`getPlotImage`	Undocumented
Method	`HTMLIncrement`	Undocumented
Method	`incrementOverlay`	Undocumented
Method	`mtxCap`	Undocumented
Method	`mtxCapMin`	Undocumented
Method	`printReport`	Undocumented
Instance Variable	`ax`	Undocumented
Instance Variable	`clr_background`	Undocumented
Instance Variable	`clr_behindplot`	Undocumented
Instance Variable	`clr_header`	Undocumented
Instance Variable	`cols`	Undocumented
Instance Variable	`fig`	Undocumented
Instance Variable	`html_string`	Undocumented
Instance Variable	`num_col`	Undocumented
Instance Variable	`outpath`	Undocumented
Instance Variable	`overlay_open`	Undocumented
Instance Variable	`table_open`	Undocumented
Instance Variable	`title`	Undocumented

def __init__(self, title, outpath, cols=3, remove_strip=False, clr_header='lightsteelblue', clr_background='lightblue', clr_behindplot='seashell'): ¶

Initialises a GeoPdb with a biopython structure

:param biopython_structure: A list of structures that has been created from biopython

def addBoxComment(self, comment): ¶

Undocumented

def addContours(self, mtx, title='', style='filled', contourlabel=False, levels=10, centred=False, palette='inferno', alpha=0.9, colourbar=True, overlay=False, cmin=None, cmax=None, cap=0, linewidth=None): ¶

:param mtx: :param title: :param style: Can be filled, lines or both :param label: label the contours :param levels: can be number or cohosen list :param centres: sets 0 as the middle in the colours (use divergent colour map) :param palette: :param alpha: :param overlay: :return:

def addDataFrame(self, data, title=''): ¶

Undocumented

def addLineComment(self, comment): ¶

Undocumented

def addPlot1d(self, data, plottype, geo_x, hue='', title='', palette='crimson', overlay=False, alpha=1, xrange=[None, None], cumulative=False, density=False, bins=20): ¶

Undocumented

def addPlot2d(self, data, plottype, geo_x, geo_y, hue, title='', palette='viridis', overlay=False, alpha=1, xrange=[None, None], yrange=[None, None], crange=[None, None]): ¶

Undocumented

def addPlotOnly(self, fig, ax): ¶

Undocumented

def addPlotPi(self, data, geo_x, hue, title='', colors=[], overlay=False, percent=False): ¶

Undocumented

def addPoints2d(self, points, hue='yellow', overlay=False): ¶

Undocumented

def addSeries(self, data, title='', transpose=False): ¶

Undocumented

def addSeries_Not(self, data, title=''): ¶

Undocumented

def addSeries_Transposed(self, data, title=''): ¶

Undocumented

def addSurface(self, mtx, title='', palette='inferno', alpha=0.9, overlay=False, cmin=None, cmax=None, cap=0, colourbar=False, centred=False): ¶

Undocumented

def changeColNumber(self, cols): ¶

Undocumented

def getFooterString(self): ¶

Undocumented

def getHeaderString(self, title, remove_strip): ¶

Undocumented

def getPlotImage(self, fig, ax): ¶

Undocumented

def HTMLIncrement(self): ¶

Undocumented

def incrementOverlay(self, overlay): ¶

Undocumented

def mtxCap(self, mtx, cap): ¶

Undocumented

def mtxCapMin(self, mtx, cap): ¶

Undocumented

def printReport(self): ¶

Undocumented

ax = ¶

Undocumented

clr_background = ¶

Undocumented

clr_behindplot = ¶

Undocumented

clr_header = ¶

Undocumented

cols = ¶

Undocumented

fig = ¶

Undocumented

html_string = ¶

Undocumented

num_col: int = ¶

Undocumented

outpath = ¶

Undocumented

overlay_open: bool = ¶

Undocumented

table_open: bool = ¶

Undocumented

title = ¶

Undocumented