Rename reduced dims (#64)

- Rename `reduced_dims` to `reduced_dimensions`. Constructor accepts both these arguments for backwards compatibility.
- Additionally, SCE's constructor takes `kwargs` for future proofing any additional attributes in the upstream classes.

Author: jkanche

CHANGELOG.md

@@ -1,16 +1,22 @@
 # Changelog
 
+## Version 0.5.8
+
+- Rename `reduced_dims` to `reduced_dimensions`. Constructor accepts both these arguments for backwards compatibility.
+- Additionally, SCE's constructor takes kwargs for future proofing any additional attributes in the upstream classes.
+
 ## Version 0.5.7
+
 - Support reading outputs from CellRanger version 3 and later in `read_tenx_mtx`.
   - Handle both `genes.csv` and `features.csv` for gene annotations.
 
 ## Version 0.5.6
 
-- Check if the column names of the alternative experiments match with the column names of the main experiment. This is the equivalent to the ``withDimnames`` parameter in the R implementation.
+- Check if the column names of the alternative experiments match with the column names of the main experiment. This is the equivalent to the `withDimnames` parameter in the R implementation.
   - On **getters** of alternative experiments, if `with_dim_names` is True, column names of the alternative experiment are **replaced** with the
-  column names of the main experiment.
+    column names of the main experiment.
   - On **setters** of alternative experiments, if `with_dim_names` is True, column names of the alternative experiment are **checked** with the
-  column names of the main experiment and an Exception is raised if they do not match.
+    column names of the main experiment and an Exception is raised if they do not match.
 
 ## Version 0.5.1 - 0.5.5
 
@@ -19,7 +25,6 @@
 - Add getters and setters to replace a specific alternative experiment or reduced dimension.
 - Fixed an issue with numpy arrays as slice arguments. Code now uses Biocutils's subset functions to perform these operations.
 
-
 ## Version 0.5.0
 
 - chore: Remove Python 3.8 (EOL)

src/singlecellexperiment/SingleCellExperiment.py

@@ -94,7 +94,7 @@ class SingleCellExperiment(RangedSummarizedExperiment):
     parent experiment. Otherwise, these cells do not share the same sample or annotations
     and cannot be set in alternative experiments!
 
-    Note: Validation checks do not apply to ``row_pairs`` or ``col_pairs``.
+    Note: Validation checks do not apply to ``row_pairs`` or ``column_pairs``.
     """
 
     def __init__(
@@ -106,13 +106,15 @@ def __init__(
         row_names: Optional[List[str]] = None,
         column_names: Optional[List[str]] = None,
         metadata: Optional[dict] = None,
-        reduced_dims: Optional[Dict[str, Any]] = None,
+        reduced_dimensions: Optional[Dict[str, Any]] = None,
+        reduced_dims: Optional[Dict[str, Any]] = None,  # deprecated name
         main_experiment_name: Optional[str] = None,
         alternative_experiments: Optional[Dict[str, Any]] = None,
         row_pairs: Optional[Any] = None,
         column_pairs: Optional[Any] = None,
         alternative_experiment_check_dim_names: bool = True,
         validate: bool = True,
+        **kwargs,
     ) -> None:
         """Initialize a single-cell experiment.
 
@@ -157,14 +159,17 @@ def __init__(
                 Additional experimental metadata describing the methods.
                 Defaults to None.
 
-            reduced_dims:
+            reduced_dimensions:
                 Slot for low-dimensionality embeddings.
 
                 Usually a dictionary with the embedding method as keys (e.g., t-SNE, UMAP)
                 and the dimensions as values.
 
                 Embeddings may be represented as a matrix or a data frame, must contain a shape.
 
+            reduced_dims:
+                Will be deprecated in the future versions. Use py:attr:`~reduced_dimensions` instead.
+
             main_experiment_name:
                 A string, specifying the main experiment name.
 
@@ -195,6 +200,9 @@ def __init__(
 
             validate:
                 Internal use only.
+
+            kwargs:
+                Additional arguments.
         """
 
         super().__init__(
@@ -206,10 +214,20 @@ def __init__(
             column_names=column_names,
             metadata=metadata,
             validate=validate,
+            **kwargs,
         )
         self._main_experiment_name = main_experiment_name
 
-        self._reduced_dims = reduced_dims if reduced_dims is not None else {}
+        _dims = None
+        if reduced_dimensions is not None and reduced_dims is not None:
+            raise ValueError("Either 'reduced_dims' or 'reduced_dimensions' should be provided, but not both.")
+        elif reduced_dims is not None:
+            warn("'reduced_dims' is deprecated, use 'reduced_dimensions' instead.", DeprecationWarning)
+            _dims = reduced_dims
+        elif reduced_dimensions is not None:
+            _dims = reduced_dimensions
+
+        self._reduced_dims = _dims if _dims is not None else {}
 
         self._alternative_experiments = alternative_experiments if alternative_experiments is not None else {}
 
@@ -551,6 +569,10 @@ def reduced_dim(self, name: Union[str, int]) -> Any:
         """Alias for :py:meth:`~get_reduced_dimension`, for back-compatibility."""
         return self.get_reduced_dimension(name=name)
 
+    def reduced_dimension(self, name: Union[str, int]) -> Any:
+        """Alias for :py:meth:`~get_reduced_dimension`, for back-compatibility."""
+        return self.get_reduced_dimension(name=name)
+
     def set_reduced_dimension(self, name: str, embedding: Any, in_place: bool = False) -> "SingleCellExperiment":
         """Add or replace :py:attr:`~singlecellexperiment.SingleCellExperiment.reduced_dimension`'s.
 

tests/test_sce.py

@@ -172,3 +172,48 @@ def test_SCE_different_alt_names():
             column_data=pd.DataFrame(index = ["ChIP", "Input", "Input"] * 2),
             alternative_experiments={"alt": rse},
         )
+
+def test_SCE_dims():
+    embeds = np.random.rand(counts.shape[1], 4)
+    tse = SingleCellExperiment(
+        assays={"counts": counts},
+        row_data=row_data,
+        column_data=col_data,
+        reduced_dimensions={
+            "something": embeds
+        }
+    )
+
+    assert tse is not None
+    assert isinstance(tse, sce)
+    assert tse.get_reduced_dimension_names() == ["something"]
+
+    tse2 = SingleCellExperiment(
+        assays={"counts": counts},
+        row_data=row_data,
+        column_data=col_data,
+        reduced_dims={
+            "something": embeds
+        }
+    )
+
+    assert tse2 is not None
+    assert isinstance(tse2, sce)
+    assert tse2.get_reduced_dimension_names() == ["something"]
+
+    print(tse.get_reduced_dimension("something"), tse2.get_reduced_dimension("something"))
+
+    assert np.allclose(tse.get_reduced_dimension("something"), tse2.get_reduced_dimension("something"))
+
+    with pytest.raises(Exception, match="Either 'reduced_dims' or 'reduced_dimensions' should be provided, but not both."):
+        SingleCellExperiment(
+            assays={"counts": counts},
+            row_data=row_data,
+            column_data=col_data,
+            reduced_dims={
+                "something": embeds
+            },
+            reduced_dimensions={
+                "something": embeds
+            }
+        )