Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

power_anova eta parameter is actually eta-squared #268

Closed
Tracked by #242
Riley16 opened this issue Jun 5, 2022 · 1 comment · Fixed by #280
Closed
Tracked by #242

power_anova eta parameter is actually eta-squared #268

Riley16 opened this issue Jun 5, 2022 · 1 comment · Fixed by #280
Labels
docs/testing:book: Documentation and unit testing

Comments

@Riley16
Copy link

Riley16 commented Jun 5, 2022

def power_anova(eta=None, k=None, n=None, power=None, alpha=0.05):

The eta parameter in power_anova (and potentially functions which I haven't checked) is actually eta-squared, but the documentation doesn't make this clear enough:
eta : float
ANOVA effect size (eta-square = 𝜂2)

The documentation as is could be taken to imply that the parameter entered by the user is eta, while the actual effect size eta-squared is the square of the user-entered parameter eta. I'd suggest making the docstring more explicit (saying something like "Actually equal to eta-squared") or renaming the parameter to eta2 or eta_squared.

@raphaelvallat
Copy link
Owner

Hi @Riley16,

(This is indirectly related to #254)

Thanks for catching this. I think that renaming the parameter to eta_squared is probably the best option to avoid any confusion! Please feel free to submit a PR. Otherwise I'll just fix this in the next release of Pingouin.

Thanks,
Raphael

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs/testing:book: Documentation and unit testing
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants