Closed sckott closed 5 years ago
I added some of the results for main weather variable outputs in the documentation for clean_daily
. Should I see if I can work some of that into the documentation for ghcnd
(only difference there I think is the variable names are in all caps) and ghcnd_search
? I've also got some information in the clean_daily
documentation that links to the online README file for the GHCND data, which gives a full list of all possible variables, units that they're in, etc. I could also add that to the documentation for the ghncd_*
family if that would be helpful.
wrt
Should I see if I can work some of that into the documentation for ghcnd and ghcnd_search
and
I could also add that to the documentation for the ghncd_* family if that would be helpful.
we don't want to duplicated documentation - if you have a separate man file for the clean_daily
function, then you leave docs in there and just link to it from ghcnd
man page e.g.
Note if there's a lot of detailed docs you have (I haven't looked at them yet) you may want to have a vignette instead, e.g., this one on NCDC attributes https://github.com/ropensci/rnoaa/blob/master/vignettes/ncdc_attributes.Rmd
Okay, in the next day or so I'll take a go at getting the balance right on amount of documentation in those.
this seems sorted now, we can reopen if folks think this needs more work