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

Describe the results from ghcnd better #148

Closed
sckott opened this issue Apr 1, 2016 · 4 comments
Closed

Describe the results from ghcnd better #148

sckott opened this issue Apr 1, 2016 · 4 comments
Labels

Comments

@sckott
Copy link
Contributor

sckott commented Apr 1, 2016

  • specifically what possible different values are in outputs
  • others?
@geanders
Copy link
Contributor

geanders commented Apr 2, 2016

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.

@sckott
Copy link
Contributor Author

sckott commented Apr 2, 2016

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

@geanders
Copy link
Contributor

geanders commented Apr 4, 2016

Okay, in the next day or so I'll take a go at getting the balance right on amount of documentation in those.

@sckott sckott added the ghcnd label Apr 11, 2016
@sckott
Copy link
Contributor Author

sckott commented Sep 11, 2019

this seems sorted now, we can reopen if folks think this needs more work

@sckott sckott closed this as completed Sep 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants