Clarification for condition table what happens if a parameter ID is provided as value
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 66
- Forks
- 16
- Avg merge
- 3h 2m
- Merged PRs (30d)
- 10
Description
Hi all,
in the condition table it should be clarified what happens if a parameter ID is provided for a parameter ID value:
https://petab.readthedocs.io/en/latest/documentation_data_format.html#condition-table
${parameterId}
The values will override any parameter values specified in the model.
Should read:
${parameterId}
The values will override any parameter values specified in the model.
If a parameter ID is provided, it is interpreted as the initial parameter value.
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
Open the condition table section of the linked PEtab documentation page and locate the ${parameterId} description. Clarify that when a parameter ID is provided, it is interpreted as the initial parameter value; the documentation is done when this behavior is stated unambiguously.
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
- 55/100