eelbrain.fmtxt.Report

class eelbrain.fmtxt.Report(title, author=None, date=True, content=None, site_title=None)

Document consisting of several sections plus a title

Parameters
  • title (FMTextLike) – Document title.

  • author (FMTextLike) – Document autho.

  • date (bool | FMTextLike) – Date to print on the report. If True (default), the current day (object initialization) is used.

  • content (FMTextLike) – Report content. Can also be constructed dynamically through the different .add_… methods.

  • site_title (str) – Set the HTML site title (the default is the same as title).

Methods

add_figure(caption[, content, options])

Add a figure frame to the section

add_image_figure(image, caption[, alt])

Add an image in a figure frame to the section

add_paragraph([content])

add_section(heading[, content])

Add a new subordinate section

append(content)

Append content to the FMText item

copy_pdf()

Copy PDF to clipboard

copy_tex()

Copy TeX to clipboard

get_html([env])

Complete HTML representation

get_rtf([env])

rtype

str

get_str([env])

String representation

get_tex(env)

TeX representation

save_html(path[, embed_images, meta])

Save HTML file of the report

save_pdf([path])

Save in PDF format

save_rtf([path])

Save in Rich Text format

save_tex([path])

Save in TeX format

save_txt([path])

Save as plain text file

show()

Save the report as temporary file and open in browser

sign([packages])

Add a signature to the report