HypothesisTests.jl icon indicating copy to clipboard operation
HypothesisTests.jl copied to clipboard

Documentation for p-value in FisherExactTest

Open andreasnoack opened this issue 8 years ago • 4 comments

~~We use a different method than R. I think we use 2x"the smaller tail" whereas R sums all values less than or equal to the reference p-value. It would be great to have it documented. Maybe we also want to use R's method.~~

Make it easier to find the pvalue documentation from the FisherExactTest documentation.

andreasnoack avatar Apr 18 '16 03:04 andreasnoack

I think this is documented here and the R method is available as method=:minlike but the documentation could probably be reorganized so this is easier to find.

simonster avatar Apr 18 '16 03:04 simonster

Ah thanks. Perfectly documented. I agree with you that since I didn't think of clicking on the pvalue link, it might be possible to make it more obvious that additional information is available there.

andreasnoack avatar Apr 18 '16 16:04 andreasnoack

Can this be closed?

The link to the p-value documentation is now quite prominent in the FisherExactTest documentation and it can be seen without clicking on the link that a specific method for the FisherExactTest exists.

I'm also happy to add a sentence to the documentation if it's not clear enough.

BenjaminBorn avatar Oct 14 '17 15:10 BenjaminBorn

Maybe we could add more information directly on the FisherExactTest docstring, since by default a p-value will be printed without even calling p-value? Possibly just something like "see p-value(::FisherExactTest) for details about the computation of the default p-value".

nalimilan avatar Oct 15 '17 19:10 nalimilan