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

API fixes #11

Closed
lrnv opened this issue Nov 12, 2020 · 1 comment · Fixed by #22
Closed

API fixes #11

lrnv opened this issue Nov 12, 2020 · 1 comment · Fixed by #22

Comments

@lrnv
Copy link
Owner

lrnv commented Nov 12, 2020

API

snake_case vs. camelCase

Functions within the package switch back and forth between using snake_case and CamelCase. It would be ideal if there could be some consistency.

cort-api-reference

https://lrnv.github.io/cort/reference/index.html

Moreover, could the reference portion of the API on the pkgdown website be split into subcategories? e.g. data/cort/copulas.

Minor note: Cort() uses N= whereas elsewhere all function parameters are lower-case.

Originally posted by @coatless in openjournals/joss-reviews#2653 (comment)

@lrnv
Copy link
Owner Author

lrnv commented Nov 13, 2020

Fixing the reference index, you can now see that the CamelCase and snake_case switches are to seperate constructors and standard (r/d/p/v)-functions from methods and the rest. Take a look at the new reference, you will see that the common uses of the two standards makes sense now that it's ordered.

For the last minor note : N is the number of bootstraps, and is intensionally given in uppercase as it is common in R, see e.g boot::boot, and many others.

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

Successfully merging a pull request may close this issue.

1 participant