Skip to content

Commit 1debfab

Browse files
committed
doc: Update README
Prettify links.
1 parent b0331bc commit 1debfab

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

README.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14183390.svg)](https://doi.org/10.5281/zenodo.14183390)
55

66

7-
The PEtab extension for model selection, including additional file formats and library.
7+
The [PEtab](https://petab.readthedocs.io/) extension for model selection,
8+
including additional file formats and library.
89

910
## Install
1011

@@ -18,24 +19,32 @@ Further documentation is available at
1819

1920
## Examples
2021

21-
There are example Jupyter notebooks covering the Python API, CLI, and visualization in the "doc/examples" directory.
22+
There are example Jupyter notebooks covering the Python API, CLI,
23+
and visualization in the `doc/examples` directory.
2224
The notebooks can be viewed at [https://petab-select.readthedocs.io/en/stable/examples.html](https://petab-select.readthedocs.io/en/stable/examples.html).
2325

2426
## Supported features
2527

26-
### Criterion
28+
PEtab Select offers various methods and criteria for model selection, as well
29+
as a variety of visualization options.
2730

28-
- `AIC`: https://en.wikipedia.org/wiki/Akaike_information_criterion#Definition
29-
- `AICc`: https://en.wikipedia.org/wiki/Akaike_information_criterion#Modification_for_small_sample_size
30-
- `BIC`: https://en.wikipedia.org/wiki/Bayesian_information_criterion#Definition
31+
### Criteria
32+
33+
- `AIC`: [Akaike information criterion](https://en.wikipedia.org/wiki/Akaike_information_criterion#Definition)
34+
- `AICc`: [Corrected Akaike information criterion](https://en.wikipedia.org/wiki/Akaike_information_criterion#Modification_for_small_sample_size)
35+
- `BIC`: [Bayesian information criterion](https://en.wikipedia.org/wiki/Bayesian_information_criterion#Definition)
3136

3237
### Methods
3338

34-
- `forward`: https://en.wikipedia.org/wiki/Stepwise_regression#Main_approaches
35-
- `backward`: https://en.wikipedia.org/wiki/Stepwise_regression#Main_approaches
39+
- `forward`:
40+
[Forward selection](https://en.wikipedia.org/wiki/Stepwise_regression#Main_approaches).
41+
Iteratively increase model complexity.
42+
- `backward`: [Backward selection](https://en.wikipedia.org/wiki/Stepwise_regression#Main_approaches).
43+
Iteratively decrease model complexity.
3644
- `brute_force`: Optimize all possible model candidates, then return the model
3745
with the best criterion value.
38-
- `famos`: https://doi.org/10.1371/journal.pcbi.1007230
46+
- `famos`:
47+
[Flexible and dynamic Algorithm for Model Selection (FAMoS)](https://doi.org/10.1371/journal.pcbi.1007230)
3948

4049
Note that the directional methods (forward, backward) find models with the
4150
smallest step size (in terms of number of estimated parameters). For example,

0 commit comments

Comments
 (0)