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

Code documentation and parameter names

Open DominiqueMakowski opened this issue 7 years ago • 1 comments

It would be easier for external users to read the code if some important steps were documented (with a comment).

Most importantly, it would be useful to write variable names with full and explicit names: For instance, in correlation_test, variable names are s2, vb, seb, that,ts, ps, qs, etc. which are quite opaque (for non-experts) and difficult to interpret, thus it's complicated to understand the internals of a function. Examples of more explicit names are pvalue, posterior, residuals, CI (credible interval), tvalue etc.

DominiqueMakowski avatar Sep 15 '18 09:09 DominiqueMakowski

Yes, excellent idea. I will go through functions and start doing this.

tszanalytics avatar Oct 07 '18 01:10 tszanalytics