Omiplots

Note

This section belongs to the extended functionality of fresfolio and requires the python packages omilayers and bokeh. Check Optional packages on how to install them.

fresfolio uses bokeh for creating interactive plots using data stored with omilayers. To create an interactive plot use the following syntax:

\begin{omiplot}
project: PROJECT
file: sections/4/foo.duckdb
layer: layer1
name: NAME
save-dir: sections/4
\end{omiplot}

  • project: it refers to the name of an existing project and is optional. If omitted, the current project is considered.

  • file: it refers to the path of an existing omilayers database. The path should be relative to the root directory of the project.

  • layer: the name of the layer stored with omilayers that holds the data for plotting.

  • name: the name of the output file. bokeh will store the plot with the extenstion .htmk. Thus, the name can be set to [NAME] or to [NAME].html.

  • save-dir: the path where the plot will be stored. This path should be relative to the root directory of the project.

HTML rendering

omiplots_rendering_1


  • plot-type: required field specifying type of plot. Currently supported scatter and line plots.

  • x-axis: required field for specifying column from the stored data that will be plotted on the x-axis.

  • y-axis: required field for specifying column from the stored data that will be plotted on the y-axis.

  • groupby: optional field for specifying categorical column for plottting x and y-axis data for each category.

  • hover: optional field for specifying one or more columns to display when hovering over the data points of the plot.

When required fields are set, the user can render the plot:

omiplots_rendering_2


As soon as the plot is rendered, the user can view the plot:

omiplots_rendering_3


fresfolio will store the plot in the path [save-dir]/[name].html. In the same path, the selected “Plot” and “Figure” options will be stored [save-dir]/[name].json. The next time the section is loaded, if the [name].html exists the “VIEW PLOT” button will be available. If the [name].json exists, the stored options will be loaded in the “Plot” and “Figure” options**”.