roxieapi.api module

roxieapi.api.generate_roxie_report(datafile_path: str, xml_path: str, notebook_output_path: str) → None

Generate a ipynb notebook report for a given datafile and output

Parameters:

• datafile_path – Input datafile

• xml_path – Input generated xml file (from roxie run)

• notebook_output_path – The generated report

roxieapi.api.plot_roxie_report(datafile_path: str, xml_path: str) → None

From a generated xml output and a roxie data file, print a report style output to the current jupyter notebook (markdown + plots), including all plots, graphs and tables

Parameters:

• datafile_path – Path to the datafile

• xml_path – Path to the generated xml