search

monarch-initiative / pheval

A framework for empirical evaluation of phenotype matching and prioritisation
https://monarch-initiative.github.io/pheval/
Apache License 2.0
12 stars 1 forks source link

Update PhEval Pipeline Documentation #352

Open souzadevinicius opened 2 weeks ago

souzadevinicius commented 2 weeks ago

Fixes #351

julesjacobsen commented 1 week ago

I would say that the Pipeline docs all belong in the monarch_pheval repo? At the very least the About section should come before the Pipeline section as there is absolutely no context about what the pipeline is even for if someone is reading the docs through from the start.

In fact, reading through the docs from the start still gives me no help in telling me how I might want to use PhEval or what it can do. A few simple examples in a logical set of steps explaining the library and the plugins to a complete beginner to lead them through to being able to write a plugin and execute a benchmark is what is needed.