Skip to content

Commit cf5d3cf

Browse files
authored
Doc: Add 'scope' section and illustration of PEtab components (#486)
* Doc: Add 'scope' section and illustration of PEtab components * Image to figure, add caption, update references * fixup
1 parent bbf5387 commit cf5d3cf

File tree

4 files changed

+1636
-3
lines changed

4 files changed

+1636
-3
lines changed

doc/documentation_data_format.rst

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,36 @@ systems biology, especially for the case of Ordinary Differential Equation
1515
(ODE) models.
1616

1717

18+
Scope
19+
-----
20+
21+
The scope of PEtab is the full specification of parameter estimation problems
22+
in typical systems biology applications. In our experience, a typical setup of
23+
data-based modeling starts either with (i) the model of a biological system
24+
that is to be calibrated, or with (ii) experimental data that are to be
25+
integrated and analyzed using a computational model.
26+
Measurements are linked to the biological model by an observation and noise
27+
model. Often, measurements are taken after some perturbations have been
28+
applied, which are modeled as derivations from a generic model
29+
(Figure 1A). Therefore, one goal was to specify such a setup in the
30+
least redundant way. Furthermore, we wanted to establish an intuitive, modular,
31+
machine- and human-readable and -writable format that makes use of existing
32+
standards.
33+
34+
.. figure:: gfx/petab_scope_and_files.png
35+
:alt: A common setup for data-based modeling studies and its representation in PEtab.
36+
:scale: 80%
37+
38+
**Figure 1: A common setup for data-based modeling studies and its representation in PEtab.**
39+
1840
Overview
1941
---------
2042

2143
The PEtab data format specifies a parameter estimation problem using a number
2244
of text-based files (`Systems Biology Markup Language (SBML) <http://sbml.org>`_
2345
and
24-
`Tab-Separated Values (TSV) <https://www.iana.org/assignments/media-types/text/tab-separated-values>`_),
25-
i.e.
46+
`Tab-Separated Values (TSV) <https://www.iana.org/assignments/media-types/text/tab-separated-values>`_)
47+
(Figure 2), i.e.
2648

2749
- An SBML model [SBML]
2850

@@ -42,9 +64,14 @@ i.e.
4264
- (optional) A visualization file, which contains specifications how the data
4365
and/or simulations should be plotted by the visualization routines [TSV]
4466

45-
.. image:: gfx/petab_files.png
67+
.. figure:: gfx/petab_files.png
4668
:alt: Files constituting a PEtab problem
4769

70+
**Figure 2: Files constituting a PEtab problem.**
71+
72+
Figure 1B shows how those files relate to a common setup for
73+
data-based modeling studies.
74+
4875
The following sections will describe the minimum requirements of those
4976
components in the core standard, which should provide all information for
5077
defining the parameter estimation problem.

doc/gfx/petab_scope_and_files.pdf

66.3 KB
Binary file not shown.

doc/gfx/petab_scope_and_files.png

167 KB
Loading

0 commit comments

Comments
 (0)