add some docstrings

MannLabs · Nov 22, 2024 · 4dd79c7 · 4dd79c7
1 parent 67044e8
commit 4dd79c7
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/alphabase/psm_reader/msfragger_reader.py b/alphabase/psm_reader/msfragger_reader.py
@@ -167,7 +167,7 @@ def _translate_decoy(self) -> None:
             self._psm_df[PsmDfCols.TO_REMOVE] += self._psm_df[PsmDfCols.DECOY] > 0
 
     def _translate_score(self) -> None:
-        # evalue score
+        """Translate MSFragger evalue to AlphaBase score: the larger the better."""
         self._psm_df[PsmDfCols.SCORE] = -np.log(self._psm_df[PsmDfCols.SCORE] + 1e-100)
 
     def _load_modifications(self, origin_df: pd.DataFrame) -> None:

diff --git a/alphabase/psm_reader/pfind_reader.py b/alphabase/psm_reader/pfind_reader.py
@@ -119,6 +119,7 @@ def _translate_decoy(self) -> None:
         ).astype(np.int8)
 
     def _translate_score(self) -> None:
+        """Translate pFind pvalue to AlphaBase score: the larger the better."""
         self._psm_df[PsmDfCols.SCORE] = -np.log(
             self._psm_df[PsmDfCols.SCORE].astype(float) + 1e-100
         )