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

Function naming and API #36

Closed
adknudson opened this issue Mar 15, 2021 · 1 comment
Closed

Function naming and API #36

adknudson opened this issue Mar 15, 2021 · 1 comment
Labels
enhancement New feature or request
Milestone

Comments

@adknudson
Copy link
Member

In an effort to achieve a 1.0 stable release, consider the following functions that can be merged by a unifying api or function:

  • cor_convert, pearson_match
  • cor_bounds, pearson_bounds
  • rvec
  • cor, cor_fast
  • cor_nearPD, cor_fastPD
  • cor_randPD, cor_randPSD

These functions can be merged and changed to be non-exported functions

  • cor_constrain, cov2cor, clamp, cor_clamp
@adknudson adknudson added the enhancement New feature or request label Mar 15, 2021
@adknudson adknudson added this to the Stable API milestone Mar 15, 2021
@adknudson
Copy link
Member Author

while some of the functions could be merged, I am choosing to leave the current API as is. Nearest correlation matrix methods have been broken off into its own package (NearestCorrelationMatrix) which has a unified API, so the cor_nearPD methods can be left as is for convenience.

cov2cor doesn't need to be exported, but R users may find it useful, so it will stay.

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

No branches or pull requests

1 participant