adding documentation of .Renviron file to vignette

reichlab / zoltr

http://reichlab.io/zoltr/

GNU General Public License v3.0

2 stars 4 forks source link

adding documentation of .Renviron file to vignette #1

Open nickreich opened 5 years ago

nickreich commented 5 years ago

Minor point, but I think being explicit about how the .Renviron file should be formatted would be helpful. Not all R users will know how to set this up.

I.e. something like

USERNAME = your-username
PASSWORD = your-password-here
PROJECT_NAME = Sandbox
MODEL_NAME = temp model
TIMEZERO_DATE = 2018-12-12
FORECAST_CSV_FILE = /path/to/your/file.csv

matthewcornell commented 5 years ago

I think we can close this because we do have a pointer to https://csgillespie.github.io/efficientR/3-3-r-startup.html#renviron from https://github.com/reichlab/zoltr/blob/master/vignettes/project-owners.Rmd . I thought that might be adequate. There's no need for info in getting-started.Rmd as it does not use environment vars.