dynamo.pl.kinetic_curves

dynamo.pl.kinetic_curves(adata, genes, mode='vector_field', basis=None, layer='X', project_back_to_high_dim=True, tkey='potential', dist_threshold=1e-10, ncol=4, color='ntr', c_palette='Set2', standard_scale=0, traj_ind=0, log=True, save_show_or_return='show', save_kwargs={})[source]

Plot the gene expression dynamics over time (pseudotime or inferred real time) as kinetic curves.

Note that by default potential estimated with the diffusion graph built from reconstructed vector field will be used as the measure of pseudotime.

Parameters
  • adata (AnnData) – an Annodata object.

  • genes (list) – The gene names whose gene expression will be faceted.

  • mode (str (default: vector_field)) – Which data mode will be used, either vector_field, lap or pseudotime. if mode is vector_field, the trajectory predicted by vector field function will be used; if mode is lap, the trajectory predicted by least action path will be used otherwise pseudotime trajectory (defined by time argument) will be used. By default potential estimated with the diffusion graph built from reconstructed vector field will be used as pseudotime when mode is pseudotime.

  • basis (str or None (default: None)) – The embedding data used for drawing the kinetic gene expression curves, only used when mode is vector_field.

  • layer (str (default: X)) – Which layer of expression value will be used. Not used if mode is vector_field.

  • project_back_to_high_dim (bool (default: False)) – Whether to map the coordinates in low dimension back to high dimension to visualize the gene expression curves, only used when mode is vector_field and basis is not X. Currently only works when basis is ‘pca’ and ‘umap’.

  • color (list or None (default: ‘ntr’)) – A list of attributes of cells (column names in the adata.obs) will be used to color cells.

  • tkey (str (default: potential)) – The .obs column that will be used for timing each cell, only used when mode is not vector_field.

  • dist_threshold (float (default: 1e-10)) – The threshold for the distance between two points in the gene expression state, i.e, x(t), x(t+1). If below this threshold, we assume steady state is achieved and those data points will not be considered. This argument is ignored when mode is pseudotime.

  • ncol (int (default: 4)) – Number of columns in each facet grid.

  • c_palette (Name of color_palette supported in seaborn color_palette function (default: None)) – The color map function to use.

  • standard_scale (int (default: 1)) – Either 0 (rows) or 1 (columns). Whether or not to standardize that dimension, meaning for each row or column, subtract the minimum and divide each by its maximum.

  • traj_ind (int (default: 0)) – If the element from the dictionary is a list (obtained from a list of trajectories), the index of trajectory that will be selected for visualization.

  • log (bool (default: True)) – Whether to log1p transform your data before data visualization. If expression data is from adata object, it is generally already log1p transformed. When the data is from predicted either from traj simulation or LAP, the data is generally in the original gene expression space and needs to be log1p transformed. Note: when predicted data is not inverse transformed back to original expression space, no transformation will be applied.

  • save_show_or_return ({‘show’, ‘save_fig’, ‘return’} (default: show)) – Whether to save_fig, show or return the figure.

  • save_kwargs (dict (default: {})) – A dictionary that will passed to the save_fig function. By default it is an empty dictionary and the save_fig function will use the {“path”: None, “prefix”: ‘kinetic_curves’, “dpi”: None, “ext”: ‘pdf’, “transparent”: True, “close”: True, “verbose”: True} as its parameters. Otherwise you can provide a dictionary that properly modify those keys according to your needs.

Returns

Return type

Nothing but plots the kinetic curves that shows the gene expression dynamics over time.