Add deprecation warning to get_df

theislab · Apr 12, 2024 · 05e8b3b · 05e8b3b
1 parent e1d6aad
commit 05e8b3b
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/scvelo/core/_anndata.py b/scvelo/core/_anndata.py
@@ -1,4 +1,5 @@
 import re
+import warnings
 from typing import List, Literal, Optional, Union
 
 import numpy as np
@@ -178,6 +179,13 @@ def get_df(
  :class:`pd.DataFrame`
  A dataframe.
  """
+ warnings.warn(
+ "`get_df` is deprecated since scvelo==0.4.0 and will be removed in a future version "
+ "of scVelo. Please `AnnData::get_df` or Scanpy's `scanpy.get.obs_df` or `scanpy.get.var_df`.",
+ DeprecationWarning,
+ stacklevel=2,
+ )
+
  if precision is not None:
  pd.set_option("display.precision", precision)