MazamaScience / AirFireModeling

Utilities to ease merging of USFS AirFire model output and monitoring data.
0 stars 0 forks source link

bluesky_load() argument names #37

Closed jonathancallahan closed 4 years ago

jonathancallahan commented 4 years ago

Elsewhere at AirFire we have adopted the following names:

We should use the same naming scheme in bluesky_load() and throughout the AirFireModeling package.

This will require updating many (most?) files in the R/, vignettes/ and tests/ subdirectories with the following changes:

This can be done manually (slow) or by using SublimeText to make changes across all files at once. Sublime can probably be used to change "modelType" to "modelMode" because "modelType" is pretty unique. But changing "model" to "modelName" will probably have to be done by hand.

I recommend using grep when you are done to make sure you've found everything.

Make sure to Check and Build before pushing the code changes. Use MazamaCoreUtils::check_slow() to make sure all examples are tested.

This task is complete when all names have been changed and the package builds with no errors, warnings or notes.

tabrasel commented 4 years ago

Can you elaborate on modelVersion? Is this a new parameter that should be added to each function?

jonathancallahan commented 4 years ago

There isn't anything for you to do right now with modelVersion. You may check that box!

This is used as an argument in some scripts based on the AirFireModeling package that insert it into a database field.

It's good that you asked because I think we should both keep it around in the back of our minds, but I don't think we have any need for it in the code at the moment.