add required minimal number of profiles to readme

CAMI-challenge / OPAL

OPAL: Open-community Profiling Assessment tooL

https://cami-challenge.github.io/OPAL/

Apache License 2.0

25 stars 6 forks source link

add required minimal number of profiles to readme #11

Closed sjanssen2 closed 6 years ago

sjanssen2 commented 6 years ago

https://github.com/CAMI-challenge/OPAL/blob/6ea499bebc0b1c7a5a8916e4c521206d50349383/opal.py#L84

It took me some time to figure out why I don't get PDFs generated. You might want to add this to the documentation and/or inform the user on stdout/stderr

fernandomeyer commented 6 years ago

I updated the documentation with a note on that (commit 7f062a2). The reason you need at least three profiles for spider plots is that they need to form at least a tringle.

I also just now added the shannon index. You get a plot for that given any number of profiles.