PEtab-dev / PEtab-dev/petab_select
Update README
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 14
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
- Add fig 1 from manuscript
- re-arrange sections (features, installation, documentation, examples)
- move this to somewhere in the docs; remove from readme
Note that the directional methods (forward, backward) find models with the smallest step size (in terms of number of estimated parameters). For example, given the forward method and a predecessor model with 2 estimated parameters, if there are no models with 3 estimated parameters, but some models with 4 estimated parameters, then the search may return candidate models with 4 estimated parameters.
Contributor guide
No contributing guide indexed for this repository
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 with the README and inspect the repository's existing documentation location before changing the structure. Add figure 1 from the manuscript, arrange the requested sections, and move the directional-methods note out of the README into the documentation. Done means the README contains the intended sections and the note no longer appears there.
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
- 45/100