Expand func names for readability

Author: jkanche

src/singlecellexperiment/SingleCellExperiment.py

@@ -350,7 +350,7 @@ def __str__(self) -> str:
     ######>> reduced_dims <<######
     ##############################
 
-    def get_reduced_dims(self) -> Dict[str, Any]:
+    def get_reduced_dimensions(self) -> Dict[str, Any]:
         """Access dimensionality embeddings.
 
         Returns:
@@ -359,7 +359,11 @@ def get_reduced_dims(self) -> Dict[str, Any]:
         """
         return self._reduced_dims
 
-    def set_reduced_dims(self, reduced_dims: Dict[str, Any], in_place: bool = False) -> "SingleCellExperiment":
+    def get_reduced_dims(self) -> Dict[str, Any]:
+        """Alias for :py:meth:`~get_reduced_dimensions`, for back-compatibility."""
+        return self.get_reduced_dimensions()
+
+    def set_reduced_dimensions(self, reduced_dims: Dict[str, Any], in_place: bool = False) -> "SingleCellExperiment":
         """Set new reduced dimensions.
 
         Args:
@@ -379,33 +383,55 @@ def set_reduced_dims(self, reduced_dims: Dict[str, Any], in_place: bool = False)
         output._reduced_dims = reduced_dims
         return output
 
+    def set_reduced_dims(self, reduced_dims: Dict[str, Any], in_place: bool = False) -> "SingleCellExperiment":
+        """Alias for :py:meth:`~set_reduced_dimensions`, for back-compatibility."""
+        return self.set_reduced_dimensions(reduced_dims=reduced_dims, in_place=in_place)
+
     @property
     def reduced_dims(self) -> Dict[str, Any]:
-        """Alias for :py:meth:`~get_reduced_dims`."""
-        return self.get_reduced_dims()
+        """Alias for :py:meth:`~get_reduced_dimensions`."""
+        return self.get_reduced_dimensions()
 
     @reduced_dims.setter
     def reduced_dims(self, reduced_dims: Dict[str, Any]):
-        """Alias for :py:meth:`~set_reduced_dims`."""
+        """Alias for :py:meth:`~set_reduced_dimensions`."""
         warn(
-            "Setting property 'reduced_dims' is an in-place operation, use 'set_reduced_dims' instead",
+            "Setting property 'reduced_dims' is an in-place operation, use 'set_reduced_dimensions' instead",
             UserWarning,
         )
-        self.set_reduced_dims(reduced_dims, in_place=True)
+        self.set_reduced_dimensions(reduced_dims, in_place=True)
+
+    @property
+    def reduced_dimensionss(self) -> Dict[str, Any]:
+        """Alias for :py:meth:`~get_reduced_dimensions`."""
+        return self.get_reduced_dimensions()
+
+    @reduced_dimensionss.setter
+    def reduced_dimensions(self, reduced_dims: Dict[str, Any]):
+        """Alias for :py:meth:`~set_reduced_dimensions`."""
+        warn(
+            "Setting property 'reduced_dimensions' is an in-place operation, use 'set_reduced_dimensions' instead",
+            UserWarning,
+        )
+        self.set_reduced_dimensions(reduced_dims, in_place=True)
 
     ####################################
     ######>> reduced_dims_names <<######
     ####################################
 
-    def get_reduced_dim_names(self) -> List[str]:
+    def get_reduced_dimension_names(self) -> List[str]:
         """Access reduced dimension names.
 
         Returns:
             List of reduced dimensionality names.
         """
         return list(self._reduced_dims.keys())
 
-    def set_reduced_dim_names(self, names: List[str], in_place: bool = False) -> "SingleCellExperiment":
+    def get_reduced_dim_names(self) -> Dict[str, Any]:
+        """Alias for :py:meth:`~get_reduced_dimension_names`, for back-compatibility."""
+        return self.get_reduced_dimension_names()
+
+    def set_reduced_dimension_names(self, names: List[str], in_place: bool = False) -> "SingleCellExperiment":
         """Replace :py:attr:`~.reduced_dims`'s names.
 
         Args:
@@ -431,29 +457,47 @@ def set_reduced_dim_names(self, names: List[str], in_place: bool = False) -> "Si
         output._reduced_dims = new_reduced_dims
         return output
 
+    def set_reduced_dim_names(self, names: List[str], in_place: bool = False) -> "SingleCellExperiment":
+        """Alias for :py:meth:`~set_reduced_dimension_names`, for back-compatibility."""
+        return self.set_reduced_dimension_names(names=names, in_place=in_place)
+
     @property
     def reduced_dim_names(self) -> List[str]:
-        """Alias for :py:meth:`~get_reduced_dim_names`."""
-        return self.get_reduced_dim_names()
+        """Alias for :py:meth:`~get_reduced_dimension_names`."""
+        return self.get_reduced_dimension_names()
 
     @reduced_dim_names.setter
     def reduced_dim_names(self, names: List[str]):
-        """Alias for :py:meth:`~set_reduced_dim_names`."""
+        """Alias for :py:meth:`~set_reduced_dimension_names`."""
+        warn(
+            "Renaming names of property 'reduced_dims' is an in-place operation, use 'set_reduced_dimension_names' instead",
+            UserWarning,
+        )
+        self.set_reduced_dimension_names(names, in_place=True)
+
+    @property
+    def reduced_dimension_names(self) -> List[str]:
+        """Alias for :py:meth:`~get_reduced_dimension_names`."""
+        return self.get_reduced_dimension_names()
+
+    @reduced_dimension_names.setter
+    def reduced_dimension_names(self, names: List[str]):
+        """Alias for :py:meth:`~set_reduced_dimension_names`."""
         warn(
-            "Renaming names of property 'reduced_dims' is an in-place operation, use 'set_reduced_dim_names' instead",
+            "Renaming names of property 'reduced_dims' is an in-place operation, use 'set_reduced_dimension_names' instead",
             UserWarning,
         )
-        self.set_reduced_dim_names(names, in_place=True)
+        self.set_reduced_dimension_names(names, in_place=True)
 
     ####################################
     ######>> reduced_dim getter <<######
     ####################################
 
-    def reduced_dim(self, dimension: Union[str, int]) -> Any:
+    def get_reduced_dimension(self, name: Union[str, int]) -> Any:
         """Access an embedding by name.
 
         Args:
-            dimension:
+            name:
                 Name or index position of the reduced dimension.
 
         Raises:
@@ -465,21 +509,48 @@ def reduced_dim(self, dimension: Union[str, int]) -> Any:
         Returns:
             The embedding.
         """
-        if isinstance(dimension, int):
-            if dimension < 0:
+        if isinstance(name, int):
+            if name < 0:
                 raise IndexError("Index cannot be negative.")
 
-            if dimension > len(self.reduced_dim_names):
+            if name > len(self.reduced_dim_names):
                 raise IndexError("Index greater than the number of reduced dimensions.")
 
-            return self._reduced_dims[self.reduced_dim_names[dimension]]
-        elif isinstance(dimension, str):
-            if dimension not in self._reduced_dims:
-                raise AttributeError(f"Reduced dimension: {dimension} does not exist.")
+            return self._reduced_dims[self.reduced_dim_names[name]]
+        elif isinstance(name, str):
+            if name not in self._reduced_dims:
+                raise AttributeError(f"Reduced dimension: {name} does not exist.")
+
+            return self._reduced_dims[name]
+
+        raise TypeError(f"'dimension' must be a string or integer, provided '{type(name)}'.")
+    
+    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 set_reduced_dimension(self, name: str, embedding: Any, in_place: bool = False) -> "SingleCellExperiment":
+        """Add or replace :py:attr:`~singlecellexperiment.SingleCellExperiment.reduced_dimension`'s.
+
+        Args:
+            name:
+                New or existing embedding or dimension name.
 
-            return self._reduced_dims[dimension]
+            embedding:
+                Embeddings may be represented as a matrix or a data frame, must contain a shape.
 
-        raise TypeError(f"'dimension' must be a string or integer, provided '{type(dimension)}'.")
+            in_place:
+                Whether to modify the ``SingleCellExperiment`` in place.
+
+        Returns:
+            A modified ``BasSingleCellExperimenteSE`` object, either as a copy of the original
+            or as a reference to the (in-place-modified) original.
+        """
+        output = self._define_output(in_place)
+        if in_place is False:
+            output._reduced_dims = output._reduced_dims.copy()
+        output._reduced_dims[name] = embedding
+        return output
 
     ################################
     ######>> main_expt_name <<######
@@ -629,7 +700,7 @@ def alternative_experiment_names(self, names: List[str]):
     ######>> alternative_experiment getter <<######
     ###############################################
 
-    def alternative_experiment(self, name: Union[str, int]) -> Any:
+    def get_alternative_experiment(self, name: Union[str, int]) -> Any:
         """Access alternative experiment by name.
 
         Args:
@@ -661,6 +732,35 @@ def alternative_experiment(self, name: Union[str, int]) -> Any:
 
         raise TypeError(f"'name' must be a string or integer, provided '{type(name)}'.")
 
+    def alternative_experiment(self, name: Union[str, int]) -> Any:
+        """Alias for :py:meth:`~get_alternative_experiment`, for back-compatibility."""
+        return self.get_alternative_experiment(name=name)
+
+    def set_alternative_experiment(self, name: str, alternative_experiment: Any, in_place: bool = False) -> "SingleCellExperiment":
+        """Add or replace :py:attr:`~singlecellexperiment.SingleCellExperiment.alternative_experiment`'s.
+
+        Args:
+            name:
+                New or existing alternative experiment name.
+
+            alternative_experiment:
+                Alternative experiments must contain the same cells (rows) as the primary experiment.
+                Is a subclasses of
+                :py:class:`~summarizedexperiment.SummarizedExperiment.SummarizedExperiment`.
+
+            in_place:
+                Whether to modify the ``SingleCellExperiment`` in place.
+
+        Returns:
+            A modified ``BasSingleCellExperimenteSE`` object, either as a copy of the original
+            or as a reference to the (in-place-modified) original.
+        """
+        output = self._define_output(in_place)
+        if in_place is False:
+            output._alternative_experiments = output._alternative_experiments.copy()
+        output._alternative_experiments[name] = alternative_experiment
+        return output
+
     ###########################
     ######>> row_pairs <<######
     ###########################

tests/test_sce.py

@@ -118,3 +118,24 @@ def test_SCE_creation_with_alts_should_fail():
             column_data=col_data,
             alternative_experiments={"alt": tse},
         )
+
+def test_SCE_creation_modifications():
+    rse = SummarizedExperiment(
+        assays={"counts": counts}, row_data=row_data, column_data=col_data
+    )
+
+    tse = SingleCellExperiment(
+        assays={"counts": counts},
+        row_data=row_data,
+        column_data=col_data,
+        alternative_experiments={"alt": rse},
+    )
+
+    assert tse is not None
+    assert isinstance(tse, sce)
+
+    nassay_tse = tse.set_reduced_dimension("something", np.random.rand(ncols - 1, 4), in_place=False)
+    assert nassay_tse.get_reduced_dimension_names() != tse.get_reduced_dimension_names()
+
+    tse.set_reduced_dimension("something", np.random.rand(ncols - 1, 4), in_place=True)
+    assert nassay_tse.get_reduced_dimension_names() == tse.get_reduced_dimension_names()