wellmap.show¶
- wellmap.show(toml_path, attrs=None, color='rainbow')[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.- 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.
attrs (str,list) – One or more attributes 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 attribute. If no attributes are specified, the default is to display any attributes that have at least two different values.color (str) – The name of the color scheme to use. Each different value for each different attribute will be assigned a color from this scheme. Any name understood by either colorcet or matplotlib can be used.
- Return type