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

JOSS review: Rename x to n in effect_size? #9

Closed
mmrabe opened this issue Nov 3, 2020 · 1 comment
Closed

JOSS review: Rename x to n in effect_size? #9

mmrabe opened this issue Nov 3, 2020 · 1 comment

Comments

@mmrabe
Copy link

mmrabe commented Nov 3, 2020

Refers to JOSS submission openjournals/joss-reviews#2810

Having the possibility to pass a function as effect_size is a very nice feature. In line with most probability distribution function in base R, would it be possible to rename the argument in the documentation to n so that it says that it requires a function signature of function(n) ...? I know it's technically already possible to do so and you state in the documentation that this argument is the number of random variates to be sampled but it may avoid confusion.

@ClaudioZandonella
Copy link
Owner

Dear @mmrabe, thanks for this suggestion that helps to enhance clarity. We agree that calling the argument n (instead of x) makes the function use much more intuitive for users. Therefore we updated all the documentation and examples.
Thanks!

At the moment the changes are in the develop branch. We will merge everything in the master branch after all changes are made.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants