Problem.add_parameter: Rename kwarg estimated->estimate (#348)

Change the `estimated` argument in Problem.add_parameter to `estimate` to match the column name. --------- Co-authored-by: Dilan Pathirana <[email protected]>
PEtab-dev · Dec 19, 2024 · 9f11e73 · 9f11e73
1 parent e7edebf
commit 9f11e73
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 18 deletions.
diff --git a/petab/v1/problem.py b/petab/v1/problem.py
@@ -1074,8 +1074,8 @@ def add_observable(
     def add_parameter(
         self,
         id_: str,
-        estimated: bool | str | int = True,
-        nominal_value=None,
+        estimate: bool | str | int = True,
+        nominal_value: Number | None = None,
         scale: str = None,
         lb: Number = None,
         ub: Number = None,
@@ -1089,7 +1089,7 @@ def add_parameter(
 
         Arguments:
             id_: The parameter id
-            estimated: Whether the parameter is estimated
+            estimate: Whether the parameter is estimated
             nominal_value: The nominal value of the parameter
             scale: The parameter scale
             lb: The lower bound of the parameter
@@ -1104,12 +1104,8 @@ def add_parameter(
         record = {
             PARAMETER_ID: [id_],
         }
-        if estimated is not None:
-            record[ESTIMATE] = [
-                int(estimated)
-                if isinstance(estimated, bool | int)
-                else estimated
-            ]
+        if estimate is not None:
+            record[ESTIMATE] = [int(estimate)]
         if nominal_value is not None:
             record[NOMINAL_VALUE] = [nominal_value]
         if scale is not None:

diff --git a/petab/v2/problem.py b/petab/v2/problem.py
@@ -829,8 +829,8 @@ def add_observable(
     def add_parameter(
         self,
         id_: str,
-        estimated: bool | str | int = True,
-        nominal_value=None,
+        estimate: bool | str | int = True,
+        nominal_value: Number | None = None,
         scale: str = None,
         lb: Number = None,
         ub: Number = None,
@@ -844,7 +844,7 @@ def add_parameter(
 
         Arguments:
             id_: The parameter id
-            estimated: Whether the parameter is estimated
+            estimate: Whether the parameter is estimated
             nominal_value: The nominal value of the parameter
             scale: The parameter scale
             lb: The lower bound of the parameter
@@ -859,12 +859,8 @@ def add_parameter(
         record = {
             PARAMETER_ID: [id_],
         }
-        if estimated is not None:
-            record[ESTIMATE] = [
-                int(estimated)
-                if isinstance(estimated, bool | int)
-                else estimated
-            ]
+        if estimate is not None:
+            record[ESTIMATE] = [int(estimate)]
         if nominal_value is not None:
             record[NOMINAL_VALUE] = [nominal_value]
         if scale is not None: