search

tisimst / pyDOE

Design of experiments for Python
BSD 3-Clause "New" or "Revised" License
263 stars 114 forks source link

"correlate"/"correlation" confusion in doe_lhs.py #4

Open Arnoques opened 8 years ago

Arnoques commented 8 years ago

Just a heads-up:

There's a mixup with the name for the correlation criterion for the Latin Hypercube. In doe_lhs.py, the documentation says "correlation" but the example says 'correlate'. The check in the code uses 'correlation', but later the if that actually selects the used function uses 'correlate'.

36:        "centermaximin" or "cm", and "correlation" or "corr". If no value 
88:        >>> lhs(4, samples=5, criterion='correlate', iterations=10)
98:            'centermaximin', 'cm', 'correlation', 
116:        elif criterion.lower() in ('correlate', 'corr'):

Thanks!

tisimst commented 8 years ago

You are correct. They all should be "correlate". Thank you for bringing that to my attention!

cjekel commented 4 years ago

I'd be happy to send a PR for this. I just ran into this issue today.