search

JohnsonHsieh / iNEXT

R package for interpolation and extrapolation
https://JohnsonHsieh.github.com/iNEXT
57 stars 26 forks source link

Documentation about the q parameter in iNEXT function #56

Open valentinitnelav opened 4 years ago

valentinitnelav commented 4 years ago

I would suggest to add a bit more details about the parameter q from the iNEXT function in the function documentation.

Currently is a numeric value specifying the diversity order of Hill number, but would be useful to know what values are possible and what each value means. Maybe something like:

a numeric value specifying the diversity order of Hill number. Possible values: 0 for species richness, 1 for Shannon diversity (exponential of Shannon entropy) and 2 for Simpson diversity (inverse of Simpson concentration).

As an R user I noticed I have to search somehow this information in vignettes or google it. Sorry, I am not an ecologist, maybe this is obvious in the ecology world :)