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

naming convention for package zoo #140

Closed
cbeleites opened this issue May 22, 2020 · 7 comments
Closed

naming convention for package zoo #140

cbeleites opened this issue May 22, 2020 · 7 comments
Labels
Note: guideline Type: proposal 💡 Proposed ideas for all to consider.

Comments

@cbeleites
Copy link
Owner

cbeleites commented May 22, 2020

How do we name the new packages?

  • @GegznaV proposes to go short names:

    I would prefer to have some shorter names as hy.import, hy.manager, hy.plot, hyperImport, hyperWrangler hyperPlot, etc.

    I agree => (+3)

Does anyone have a strong opinion on

  • CamelCase (hyperChemoBridge) vs.
  • dots (hyperSpec.dplyr or hy.dplyr) (+3) vs.
  • underscores (hy_io_spc, hy_dplyr) not possible according to @GegznaV

=> please edit this comment and +1 behind your choice.

Bryan: no strong opinion as to name convention, you might consider hyS.X (add an "S") rather than just hy.X so that users might see that it goes with hyperSpec if they are browsing around.

@eoduniyi
Copy link
Collaborator

I agree with @bryanhanson: I think it should be more than just hy.X as there is potential confusion between the hyperSpec universe and the Hy programming language, the interesting Hy.ly startup, or the English phonetic abbreviation hy.

I have a preference for the following: hyS.X,hySp.X (could be confused with this or this), or my favorite hySpc.X.

# Install and load hyperSpec bridge packages
install.packages("hySpc.import") # this may get installed/loaded with library(hyperSpec) as default
library(hySpc.import)
.
.
.
# Import/read Kaiser file
hySpc.import::Kaiser()

@bryanhanson
Copy link
Collaborator

hySpc.X is Excellent!

@GegznaV
Copy link
Collaborator

GegznaV commented May 25, 2020

I'd prefer to use all non-capital letters. Of course, with RStudio's auto-complete possibilities it is not a big problem, but still...
hy.etc was just an example of an idea as some functions, e.g., hyperSpec::hy.getOption() and chk.hy(), use this abbreviation.

@ximeg
Copy link
Collaborator

ximeg commented May 25, 2020

@eoduniyi you've done some legwork 😄 hySpc.<X> is a great suggestion, but I agree with Vilmantas, that lower-case would be easier to type: hyspc.<X>.

@ximeg
Copy link
Collaborator

ximeg commented May 25, 2020

@ximeg
Copy link
Collaborator

ximeg commented May 25, 2020

Together we agreed on hySpc.<x> naming. The capitalization is there to be consistent with hyperSpec, where S is capitalized.

@bryanhanson
Copy link
Collaborator

Closing as this has been resolved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Note: guideline Type: proposal 💡 Proposed ideas for all to consider.
Projects
None yet
Development

No branches or pull requests

5 participants