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

General refactor #74

Open
BaptisteDlp opened this issue Nov 28, 2023 · 3 comments
Open

General refactor #74

BaptisteDlp opened this issue Nov 28, 2023 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@BaptisteDlp
Copy link
Collaborator

What is your issue?

In order for the whole code to be more readable, I suggest doing what follows:

  • Apply uppercase for all constants in data-raw/internalData.R and everywhere they are used
  • Create a R/modelUtils.R file which contains the defintions of models, functions for asymmetry and other utility/helper functions used in both spatialBehaviour and temporalBehaviour functions
@BaptisteDlp BaptisteDlp added the enhancement New feature or request label Nov 28, 2023
@thomasarsouze
Copy link
Contributor

Apply uppercase for all constants in data-raw/internalData.R and everywhere they are used

I would not recommend that. Convention is the use of CamelCase everywhere for variables. I think it's best if we manage to stick with it.

Create a R/modelUtils.R file which contains the defintions of models, functions for asymmetry and other utility/helper functions used in both spatialBehaviour and temporalBehaviour functions

This can be a good idea, to separate the models part from actual dealing of internal Behaviour functions.
Do you have a list in mind ? What I can think of :

  • getRmw
  • willoughby
  • holland
  • boose
  • computeWindProfile
  • computeAsymmetry
  • computeDirectionBoose
  • computeDirection
  • computePDI
  • computeExposure
  • computeProduct

@BaptisteDlp
Copy link
Collaborator Author

Agree with this list

@thomasarsouze
Copy link
Contributor

@BaptisteDlp : now that all development branches have been merge, we can do this small refactoring. Also, please update the README.

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

3 participants