PEtab-dev / PEtab-dev/PEtab

Clarification of condition table what happens if NaN is provided as a value

Open
#542 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

v1
Dominant language
No language data
Stars
66
Forks
16
Avg merge
3h 2m
Merged PRs (30d)
10

Description

I.e. on
https://petab.readthedocs.io/en/latest/documentation_data_format.html#condition-table
The NaN case is listed for speciesID but not for compartmentID and parameterID. It is unclear what happens here, but I assume the initial values of the model should be taken.

The sentence

the values will override any parameter values specified in the model.

reads for me, that you have to set the NaN.

See also discussion in https://github.com/AMICI-dev/AMICI/issues/1796

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the condition-table section in the linked PEtab documentation and review the related AMICI issue discussion. Determine the intended behavior when NaN is used for compartmentID and parameterID, then clarify the table and the sentence about overriding model parameter values so the documented behavior is unambiguous.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.