trepr.report module

General facilities to generate a report.

To do scientific research in terms of reproducibility and traceability it’s highly necessary to report all the steps done on a given dataset and never separate the dataset from its metadata.

This module provides functionality to create a report containing a 1D and 2D plot of the dataset, its metadata and all processing steps including parameters.

class trepr.report.LaTeXReporter(template='', filename='')

Bases: aspecd.report.LaTeXReporter

Generate a report based on a LaTeX template provided.

An example for using the trepr.report.LaTeXReporter class may look like this:

template_ = 'path/to/your/template.tex'
report_output = 'path/to/your/report_output.tex'
dataset_ = trepr.dataset.ExperimentalDataset()
report = LaTeXReporter(template_, report_output)
report.dataset = dataset_
report.create()
report.compile()
Parameters
  • template (str) – Path to template file used to generate report.

  • filename (str) – Path of the resulting template file.

dataset

Dataset structure containing raw dat as well as metadata.

Type

trepr.dataset.Dataset

create()

Perform all methods to generate a report.