Skip to content

Commit fcccbcf

Browse files
committed
Allow using observable IDs in observableFormula and noiseFormula (#562)
Following up on #543 and the discussion during the last PEtab editor meeting: There was general consent to allow using observableIDs in the `noiseFormula` column in the observables table. Closes #543.
1 parent 5fa0f1f commit fcccbcf

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

doc/documentation_data_format.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,9 @@ Detailed field description
340340
Observation function as plain text formula expression.
341341
May contain any symbol defined in the SBML model (including model time ``time``)
342342
or parameter table. In the simplest case just an SBML species ID
343-
or an ``AssignmentRule`` target.
343+
or an ``AssignmentRule`` target. Additionally, any observable ID
344+
introduced in the observable table may be referenced, but circular definitions
345+
must be avoided.
344346

345347
May introduce new parameters of the form ``observableParameter${n}_${observableId}``,
346348
which are overridden by ``observableParameters`` in the measurement table
@@ -362,10 +364,14 @@ Detailed field description
362364
observable.
363365

364366
Alternatively, some formula expression can be provided to specify
365-
more complex noise models. A noise model which accounts for relative and
367+
more complex noise models. The formula may reference any uniquely identifiable
368+
model entity with PEtab-compatible identifier or any observable ID
369+
specified in the observable table.
370+
371+
A noise model which accounts for relative and
366372
absolute contributions could, e.g., be defined as::
367373

368-
noiseParameter1_observable_pErk + noiseParameter2_observable_pErk*pErk
374+
noiseParameter1_observable_pErk + noiseParameter2_observable_pErk * observable_pErk
369375

370376
with ``noiseParameter1_observable_pErk`` denoting the absolute and
371377
``noiseParameter2_observable_pErk`` the relative contribution for the

0 commit comments

Comments
 (0)