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 conventions #48

Closed
OAGr opened this issue Jan 5, 2016 · 1 comment
Closed

Naming conventions #48

OAGr opened this issue Jan 5, 2016 · 1 comment

Comments

@OAGr
Copy link
Member

OAGr commented Jan 5, 2016

The naming conventions are always pretty important, I wanted to lay out what we have and ask if there are any strong opinions on this.

Model: One guesstimate spreadsheet
Metric: The thing that fills a cell and has a value ('people in iowa')
Guesstimate: The thing that goes into the number field of a Metric. In the future there could be many guesstimates for one metric, so you'll see in the code base there's a one-to-many relationship.
Simulation: A Monte Carlo simulation. Stores around 5k samples and some metadata. Belongs to a guesstimate.

In the codebase 'Model' is often written as 'space', which is what it used to be called. I'll try to change this sooner than later, as I could see that getting confusing.

@OAGr OAGr changed the title Discuss: Naming conventions Naming conventions Jan 11, 2016
@OAGr OAGr closed this as completed Jun 16, 2016
@OAGr
Copy link
Member Author

OAGr commented Jun 16, 2016

This is what we've been going with, though not so much with the term 'Guesstimate', which may change. In general people seem to be ok with model/metric/simulation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant