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 structure #34

Open
edhofman opened this issue Apr 21, 2024 · 0 comments
Open

Naming structure #34

edhofman opened this issue Apr 21, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@edhofman
Copy link
Owner

edhofman commented Apr 21, 2024

Ola!

To streamline the package further I propose we adapt a consistent naming structure throughout the package.
Here is a proposal:

Objects : Following Pascal case (first letter capital, each new word in capital, no seperator), that is : ReSurvPredict, IndividualData. I believe we have already done this.

Functions : I propose snake_case but with dot seperator ( first letter low case, each new word in lowcase, seperated by ".") : survival.information, model.matrix.encoder. This is the main naming convention used, but not consistent across everything.

Variables : I propose snake_case (same as above but with "_" seperator ). Perhaps we can use capital first letter for tables and lower case for vectors / single values. This is probably the largest change, and I am sure we will rename somewhere and forget elsewhere, but would be nice for consistency :).

@edhofman edhofman added the enhancement New feature or request label Apr 21, 2024
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

2 participants