dynamo.configuration.set_figure_params

dynamo.configuration.set_figure_params(dynamo=True, background='white', fontsize=8, figsize=(6, 4), dpi=None, dpi_save=None, frameon=None, vector_friendly=True, color_map=None, format='pdf', transparent=False, ipython_format='png2x')[source]
Set resolution/size, styling and format of figures.

This function is adapted from: https://github.com/theislab/scanpy/blob/f539870d7484675876281eb1c475595bf4a69bdb/scanpy/_settings.py

Parameters:

  • dynamo (bool) – Init default values for matplotlib.rcParams suited for dynamo.

  • background (str) – The background color of the plot. By default we use the white ground which is suitable for producing figures for publication. Setting it to black background will be great for presentation.

  • fontsize (float) – Size of font.

  • figsize (Tuple[float, float]) – Width and height for default figure size.

  • dpi (Optional[int]) – Resolution of rendered figures - this influences the size of figures in notebooks.

  • dpi_save (Optional[int]) – Resolution of saved figures. This should typically be higher to achieve publication quality.

  • frameon (Optional[bool]) – Add frames and axes labels to scatter plots.

  • vector_friendly (bool) – Plot scatter plots using png backend even when exporting as pdf or svg.

  • color_map (Optional[str]) – Convenience method for setting the default color map.

  • format (str) – This sets the default format for saving figures: file_format_figs. This can be png, pdf, svg, etc.

  • transparent (bool) – Save figures with transparent background. Sets rcParams[‘savefig.transparent’].

  • ipython_format (str) – Only concerns the notebook/IPython environment; see IPython.core.display.set_matplotlib_formats for more details.