wellmap.show
- wellmap.show(toml_path, params=None, *, style=None)[source]
Visualize the given microplate layout.
It’s wise to visualize TOML layouts before doing any analysis, to ensure that all of the wells are correctly annotated. The
wellmapcommand-line program is a useful tool for doing this, but sometimes it’s more convenient to make visualizations directly from python (e.g. when working in a jupyter notebook). That’s what this function is for.Note
Jupyter will display the layout twice when you use this function, unless you put a semicolon after it. See #19 for more information.
- Parameters:
toml_path (str,pathlib.Path) – The path to a file describing the layout of one or more plates. See the File format page for details about this file.
params (str,list) – The names of one or more experimental parameters from the above TOML file to visualize. For example, if the TOML file contains something equivalent to
well.A1.conc = 1, then “conc” would be a valid parameter name. If not specified, the default is to display any parameters that have at least two different values.style (Style) – Settings that control miscellaneous aspects of the plot, e.g. colors, dimensions, etc.
- Return type: