v2: Add how-tos
Open
Nobody has claimed this yet.
documentation
- Dominant language
- No language data
- Stars
- 66
- Forks
- 16
- Avg merge
- 3h 2m
- Merged PRs (30d)
- 10
Description
I think it would be helpful to have some how-tos for addressing common application problems in PEtab (in additional to the basic tutorial).
Some cases that come to mind:
- Dealing with relative measurements (-> scaling parameters)
- Batch effects (-> condition-specific observable/noise parameters)
- Use of multiple models and model-specific parameter values (https://github.com/PEtab-dev/PEtab/pull/622#discussion_r2185711565)
- ...
The simple cases can probably also be addressed in some FAQ section.
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 by reviewing the basic tutorial and the issue's proposed cases: relative measurements, batch effects, and multiple models with model-specific parameter values. Define the how-to or FAQ scope and document the selected cases with enough guidance for common PEtab application problems; the issue does not name files or tests to run.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100