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

Rename functions (5): decomposition #303

Closed
GegznaV opened this issue Feb 11, 2021 · 2 comments
Closed

Rename functions (5): decomposition #303

GegznaV opened this issue Feb 11, 2021 · 2 comments
Labels
Status: under consideration ❗ Topic is under discussion. No decision yet. Topic: rename ♻️ Topic: style ✏️ Related to code style (documentation, R scripts, etc.) Type: enhancement 🎈 asking for a new feature.

Comments

@GegznaV
Copy link
Collaborator

GegznaV commented Feb 11, 2021

This issue complements #208 (comment).

These functions may also be renamed. But extension or modification of functionality should also be introduced.

Current name Suggested name Comment Note
decomposition as.hyperSpec(<matrix>), as_hyperSpec(<matrix>)
scores2hyperSpec()
loadings2hyperSpec()
Function can not only renamed bu also redefined as a method of as.hyperSpec(), as_hyperSpec(). See discussion in #144. Related #289 This issue moved to r-hyperspec/hyperSpec#55
chk.hy is.hyperSpec(), is_hyperSpec() 1. May include the functionality of validObject() as well.
2. To keep current functionality (failure in case of non-hyperSpec object), argument fail = TRUE may be added. Default should be fail = FALSE to return FALSE.
Solved in r-hyperspec/hyperSpec#35
@GegznaV GegznaV added Type: enhancement 🎈 asking for a new feature. Topic: style ✏️ Related to code style (documentation, R scripts, etc.) Topic: rename ♻️ labels Feb 11, 2021
@bryanhanson
Copy link
Collaborator

bryanhanson commented Feb 15, 2021

Regarding chk.hy also take a look at #130 and the cross-references there-in. I think all these concerns can be fixed at once.

Regarding decomposition I authored #144 so I agree this should be renamed.

Somewhat related: decomposition will create a hyperSpec object containing loadings or scores. If loadings, then plotspc should be used, but if scores, plotc should be used. plotc also has other uses. I have not looked at this in detail, but from a user-friendliness point of view, it would be nice if plotc and plotspc were merged, made generic and employed the formula interface like plotc does to specify what should be plotted. Some careful checking of dimensions would be needed to intercept user errors like calling for a plot that does not make sense with the matrix dimensions.

@GegznaV GegznaV added the Status: under consideration ❗ Topic is under discussion. No decision yet. label Feb 23, 2021
@GegznaV GegznaV changed the title Rename functions (5): decomposition & chk.hy Rename functions (5): decomposition Aug 4, 2021
@GegznaV
Copy link
Collaborator Author

GegznaV commented Aug 12, 2021

This discussion moved and reopen as:

@GegznaV GegznaV closed this as completed Aug 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: under consideration ❗ Topic is under discussion. No decision yet. Topic: rename ♻️ Topic: style ✏️ Related to code style (documentation, R scripts, etc.) Type: enhancement 🎈 asking for a new feature.
Projects
None yet
Development

No branches or pull requests

2 participants