Skip to content

Commit 6e7ddc8

Browse files
dweindldilpath
andauthored
Reword observableParameters / noiseParameters description (#651)
Reword observableParameters / noiseParameters description and make them more self-contained. Previously, this was too specific to normal noise models. --------- Co-authored-by: Dilan Pathirana <59329744+dilpath@users.noreply.github.com>
1 parent 8139df9 commit 6e7ddc8

1 file changed

Lines changed: 41 additions & 20 deletions

File tree

doc/v2/documentation_data_format.rst

Lines changed: 41 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -419,13 +419,13 @@ The experiment table has three mandatory columns ``experimentId``,
419419
In PEtab, the steady state definition is that *all* differential entities
420420
are at steady state, meaning that all differential entities have reached,
421421
and will remain at, a constant value.
422-
422+
423423
Determining whether differential entities are at steady state is left to
424424
the simulator and user. Reasonable numerical criteria should be used
425425
to determine whether a steady state is reached. Users should
426426
share their chosen numerical criteria when sharing their model, for
427427
reproducibility.
428-
428+
429429
It can be difficult to determine whether the differential entities are
430430
at steady state. For example, events and other discontinuities may
431431
occur after an apparent steady state is reached. It is left to the user to
@@ -540,39 +540,60 @@ Detailed field description
540540

541541
- ``observableParameters`` [NUMERIC, STRING OR NULL, OPTIONAL]
542542

543-
Measurement-specific overrides for placeholder parameters declared in the
544-
observation model.
543+
Measurement-specific overrides for placeholder parameters in the
544+
`observableFormula` declared in the
545+
:ref:`observable table <v2_observable_table>`.
545546

546547
The :ref:`observable table <v2_observable_table>` allows marking some
547-
parameters as measurement-specific (see below). Their values for a given
548-
measurement are specified in this column. The values are separated by
549-
semicolons. The order and number of values must match the order and number of
548+
parameters as measurement-specific (see `observablePlaceholders` there).
549+
Their values for a given measurement are specified in this column.
550+
The values are separated by semicolons.
551+
The order and number of values must match the order and number of
550552
placeholders in the ``observablePlaceholders`` field of the corresponding
551-
observable in the observable table. The values may be
552-
either numeric values or the IDs of parameters from the
553+
observable in the observable table. I.e., if the observable table contains
554+
no observable placeholders for the given observable, this field must be
555+
empty.
556+
The values may be either numeric values or the IDs of parameters from the
553557
:ref:`parameter table <v2_parameter_table>`.
554558

555-
Different lines for the same ``observableId`` may specify different
556-
parameters. This may be used to account for condition-specific or
557-
batch-specific parameters. This will translate into an extended estimation
558-
parameter vector.
559+
Different measurements for the same ``observableId`` may specify different
560+
values. This may be used to account for condition-specific or
561+
batch-specific parameters.
559562

560-
If there are no placeholders used, this column may be omitted.
563+
If none of the observables referenced in a given measurement table use any
564+
noise placeholders, this column may be omitted there.
561565

562566
- ``noiseParameters`` [NUMERIC, STRING OR NULL, OPTIONAL]
563567

564-
The measurement standard deviation or empty if the corresponding sigma is a
565-
model parameter.
568+
Measurement-specific overrides for placeholder parameters in the
569+
`noiseFormula` declared in the
570+
:ref:`observable table <v2_observable_table>`.
571+
572+
The :ref:`observable table <v2_observable_table>` allows marking some
573+
parameters as measurement-specific (see `noisePlaceholders` there).
574+
Their values for a given measurement are specified in this column.
575+
The values are separated by semicolons.
576+
The order and number of values must match the order and number of
577+
placeholders in the ``noisePlaceholders`` field of the corresponding
578+
observable in the observable table. I.e., if the observable table contains
579+
no noise placeholders for the given observable, this field must be
580+
empty.
581+
The values may be either numeric values or the IDs of parameters from the
582+
:ref:`parameter table <v2_parameter_table>`.
583+
584+
Different measurements for the same ``observableId`` may specify different
585+
values. This may be used to account for condition-specific or
586+
batch-specific parameters.
566587

567-
Numeric values or parameter names are allowed. Same rules apply as for
568-
``observableParameters`` in the previous point.
588+
If none of the observables referenced in a given measurement table use any
589+
noise placeholders, this column may be omitted there.
569590

570591
- ``modelId`` [PETAB_ID, OPTIONAL, REFERENCES(yaml.models.model_id)]
571592

572593
Which model to simulate for each data point. Model IDs are defined by the
573594
keys of the `models` object in the PEtab problem YAML file.
574595
This column is required when multiple models are defined in the PEtab
575-
problem.
596+
problem (see :ref:`v2_multiple_models`).
576597
For problems with a single model, this column is optional,
577598
and its values default to the ID of the only model present.
578599

@@ -979,7 +1000,7 @@ Mapping table
9791000
-------------
9801001

9811002
The mapping table maps PEtab entity IDs to model entity IDs, and may be used
982-
for additional annotations. This file is optional.
1003+
for additional annotations of model or PEtab entities. This file is optional.
9831004

9841005
This file may be used to provide PEtab-compatible aliases to model entities
9851006
whose ID in the model would not be a valid identifier in PEtab

0 commit comments

Comments
 (0)