Skip to content

Commit f95ec67

Browse files
committed
v2: Change parameter.estimate from 0/1 to true/false
Meanwhile, boolean literals are supported in math expressions, so we should also use them for the boolean `estimate` column.
1 parent 0813783 commit f95ec67

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

doc/v2/documentation_data_format.rst

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,8 @@ PEtab 2.0.0 is a major update of the PEtab format. The main changes are:
143143
parameter priors was not well-defined.
144144
To obtain the same effect, the model parameters can be transformed in the
145145
model file.
146+
* The admissible values for ``estimate`` in the :ref:`v2_parameters_table`
147+
are now ``true`` and ``false`` instead of ``1`` and ``0``.
146148

147149
.. _v2_model:
148150
.. _v2_model_entities:
@@ -717,15 +719,15 @@ it *may* include:
717719

718720
One row per parameter with arbitrary order of rows and columns:
719721

720-
+-------------+-----------------+-------------+------------+--------------+----------+-----+
721-
| parameterId | [parameterName] | lowerBound | upperBound | nominalValue | estimate | ... |
722-
+=============+=================+=============+============+==============+==========+=====+
723-
| PETAB_ID | [STRING] | NUMERIC | NUMERIC | NUMERIC | 0\|1 | ... |
724-
+-------------+-----------------+-------------+------------+--------------+----------+-----+
725-
| k1 | | 1e-5 | 1e5 | 100 | 1 | ... |
726-
+-------------+-----------------+-------------+------------+--------------+----------+-----+
727-
| ... | ... | ... | ... | ... | ... | ... |
728-
+-------------+-----------------+-------------+------------+--------------+----------+-----+
722+
+-------------+-----------------+-------------+------------+--------------+-------------+-----+
723+
| parameterId | [parameterName] | lowerBound | upperBound | nominalValue | estimate | ... |
724+
+=============+=================+=============+============+==============+=============+=====+
725+
| PETAB_ID | [STRING] | NUMERIC | NUMERIC | NUMERIC | true\|false | ... |
726+
+-------------+-----------------+-------------+------------+--------------+-------------+-----+
727+
| k1 | | 1e-5 | 1e5 | 100 | true | ... |
728+
+-------------+-----------------+-------------+------------+--------------+-------------+-----+
729+
| ... | ... | ... | ... | ... | ... | ... |
730+
+-------------+-----------------+-------------+------------+--------------+-------------+-----+
729731

730732
*(wrapped for readability)*
731733

@@ -761,23 +763,24 @@ Detailed field description
761763
- ``lowerBound`` [NUMERIC]
762764

763765
Lower bound of the parameter used for estimation.
764-
Optional, if ``estimate==0``.
766+
Optional, if ``estimate==false``.
765767

766768
- ``upperBound`` [NUMERIC]
767769

768770
Upper bound of the parameter used for estimation.
769-
Optional, if ``estimate==0``.
771+
Optional, if ``estimate==false``.
770772

771773
- ``nominalValue`` [NUMERIC]
772774

773775
Some parameter value to be used if
774776
the parameter is not subject to estimation (see ``estimate`` below).
775-
Optional, unless ``estimate==0``.
777+
Optional, unless ``estimate==false``.
776778

777-
- ``estimate`` [BOOL 0|1]
779+
- ``estimate`` [``true`` | ``false``]
778780

779-
1 or 0, depending on, if the parameter is estimated (1) or set to a fixed
780-
value(0) (see ``nominalValue``).
781+
``true`` or ``false`` (case-sensitive), depending on, if the parameter is
782+
estimated (``true``) or set to a fixed value (``false``)
783+
(see ``nominalValue``).
781784

782785
- ``initializationPriorType`` [STRING, OPTIONAL]
783786

0 commit comments

Comments
 (0)