add docstrings

PEtab-dev · Feb 6, 2020 · 3ad1a40 · 3ad1a40
1 parent 801eee3
commit 3ad1a40
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/petab/problem.py b/petab/problem.py
@@ -353,7 +353,8 @@ def x_nominal(self) -> List:
 
     @property
     def x_nominal_estimate(self) -> List:
-        estimated = self.parameter_df[self.parameter_df[ESTIMATE] == 1]
+        """Parameter table nominal values, for parameters to estimate."""
+        estimated = self.parameter_df[self.parameter_df[ESTIMATE] != 0]
         return list(estimated[NOMINAL_VALUE])
 
     @property
@@ -374,7 +375,9 @@ def x_nominal_scaled(self) -> List:
 
     @property
     def x_nominal_estimate_scaled(self) -> List:
-        estimated = self.parameter_df[self.parameter_df[ESTIMATE] == 1]
+        """Parameter table nominal values with applied parameter scaling,
+        for parameters to estimate."""
+        estimated = self.parameter_df[self.parameter_df[ESTIMATE] != 0]
         return list(parameters.map_scale(estimated[NOMINAL_VALUE],
                                          estimated[PARAMETER_SCALE]))