Condition table not specified for parameters governed by rate rules
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 66
- Forks
- 16
- Avg merge
- 3h 2m
- Merged PRs (30d)
- 10
Description
Which problem would you like to address? Please describe.
Parameters in SBML can be either constant=True or constant=False. In case of constant=False the parameter can be either governed by an AssignmentRule or a RateRule. In case of a RateRule the parameter becomes a state variable in the ODE (analoque to species and compartments which are constant=False and governed by a RateRule or in case of species by reactions).
For such parameters which are governed by RateRules a typical condition is to set the initial value of the state variable, but this is currently not mentioned in the condition table.
See also https://github.com/AMICI-dev/AMICI/issues/1750 for an example PETab problem.
Describe the solution you would like
I propose to clarify the description of the condition table, i.e.,
I.e. the more correct way for the condition table description in
https://petab.readthedocs.io/en/latest/documentation_data_format.html#condition-table
should be
The condition table specifies constant parameters, or initial values of species, compartments or parameters for specific simulation conditions (generally corresponding to different experimental conditions).
instead of
The condition table specifies parameters, or initial values of species and compartments for specific simulation conditions (generally corresponding to different experimental conditions).
Describe alternatives you have considered
An alternative is to encode the parameter as a species or compartment governed by a RateRule. While this would be supported, the semantics would be incorrect and also the units would create problems.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the condition-table section of documentation_data_format.html and review the current condition table description against the issue's proposed wording. Update the documentation to mention initial values of parameters governed by RateRules, then check the rendered page for clarity and formatting.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100