report
utils.report
Report Module
This module provides utilities for generating reports related to model parameters and configurations.
.. moduleauthor:: Leon K. Martin
Attributes:
from tvbo import ontology, config import operator import pandas as pd
Functions:
Functions
| Name | Description |
|---|---|
| get_citation | Retrieve a BibTeX entry by its citation key and render it as an APA-style plain text citation. |
| model_report | Generate a report for the model. |
| parameter_report | Generate a report of parameter settings. |
| render_citation | Render an ontology citation instance as formatted text. |
| save_latex | Save a LaTeX report to a file. |
get_citation
utils.report.get_citation(citation_key)Retrieve a BibTeX entry by its citation key and render it as an APA-style plain text citation.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| citation_key | str | The citation key to retrieve. | required |
Returns
| Name | Type | Description |
|---|---|---|
| str | str | The citation formatted in APA style, or an error message if not found. |
model_report
utils.report.model_report()Generate a report for the model.
Returns
None
parameter_report
utils.report.parameter_report(
param_setting,
decimals=3,
format='latex',
**kwargs,
)Generate a report of parameter settings.
Parameters
param_setting : object Parameter setting object. decimals : int, optional Number of decimal places for formatting. Default is 3. format : str, optional Format for the report: ‘latex’, ‘pandas’, or ‘markdown’. Default is ‘latex’. **kwargs : Additional keyword arguments.
Returns
pandas.DataFrame or str Report table if format is ‘pandas’, LaTeX string if format is ‘latex’, or markdown string if format is ‘markdown’.
Raises
ValueError If the provided format is not recognized.
render_citation
utils.report.render_citation(citation, style='apa')Render an ontology citation instance as formatted text.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| citation | An owlready2 instance with author, year, title, journal, volume, pages, label. | required | |
| style | ‘bibtex’ or ‘apa’. | 'apa' |
Returns
| Name | Type | Description |
|---|---|---|
| str | The formatted citation. |
save_latex
utils.report.save_latex(conf, fpath)Save a LaTeX report to a file.
Parameters
conf : object Configuration object. fpath : str File path to save the LaTeX report.
Returns
None