piLaboratory / GillesCom

Gillespie Simulation of Ecological Communities Dynamics
2 stars 0 forks source link

Function / object naming conventions #12

Closed andrechalom closed 8 years ago

andrechalom commented 8 years ago

Currently, we have the functions time and history, which clash with stats::time and stats::history. We need to come up with better names to rename those functions and avoid namespace clashes.

Also, it is a good design practice to determine standard naming conventions for the functions and othe relevant objects in the package.

piklprado commented 8 years ago

Sure. I'll try to keep the new names as mnemonic and informative as time and history are. Maybe time_ellapsed and trajectories ?

piklprado commented 8 years ago

Also, we have to change the name of ls.m that can conflict with ls S3 methods.

andrechalom commented 8 years ago

I will hold this issue while waiting for the open PRs to be merged.

andrechalom commented 8 years ago

Changing the following:

We could change things like diagPlots() to diag_plots() - changed camelCase to underscores, as it is more readable. But I don't think that's necessary.

I'm leaving Init_Community and GillesComFromFile/GillesComToFile as uppercase because these are very special function in the way that they handles directly with the underlying constructor.

All of these changed already on master branch.

andrechalom commented 8 years ago

OK, can we close this?

piklprado commented 8 years ago

Ok! Can you merge into dev please?

andrechalom commented 8 years ago

You have already merged this changes on d090452