Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.
Sign upGSODR: Global Surface Summary Daily Weather Data in R #79
Comments
sckott
added
package
1/editor-checks
labels
Oct 14, 2016
sckott
self-assigned this
Oct 14, 2016
This comment has been minimized.
This comment has been minimized.
@sckott, I've found a bug that I need to fix. Not sure how it's crept in. I will report back when it's corrected. |
This comment has been minimized.
This comment has been minimized.
Well that was embarrassing. It's all fixed now, @sckott. Glad I checked the package build again this morning. |
sckott
added
topic:data-access
topic:climate-data
2/seeking-reviewer(s)
and removed
1/editor-checks
labels
Oct 15, 2016
This comment has been minimized.
This comment has been minimized.
Editor checks:
Editor commentsThanks for your submission @adamhsparks - no worries about eth bug Will be seeking reviewers, but in the meantime: I ran
Reviewers: @jeffreyhanson @deniederhut |
This comment has been minimized.
This comment has been minimized.
Thanks for the valuable feedback. This is exactly the type of suggestions I was looking for here. I'll get as much of this done as I can shortly. |
This comment has been minimized.
This comment has been minimized.
I've updated the DESCRIPTION file in the package and here in this issue as suggested. |
This comment has been minimized.
This comment has been minimized.
Vignette builds faster now, as suggested as well. |
This comment has been minimized.
This comment has been minimized.
Tomislav Hengl has contributed to the package and is now an author. I'll be merging his commits as I have time. However, I'll be on travel this week. So it may take me a while to address this. |
This comment has been minimized.
This comment has been minimized.
Thanks for the updates @adamhsparks - seeking reviewers |
sckott
added
3/reviewer(s)-assigned
and removed
2/seeking-reviewer(s)
labels
Oct 20, 2016
This comment has been minimized.
This comment has been minimized.
jeffreyhanson
commented
Oct 20, 2016
•
Package ReviewPlease check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide
DocumentationThe package includes all the following forms of documentation:
Paper (for packages co-submitting to JOSS)The package contains a
Functionality
Final approval (post-review)
Estimated hours spent reviewing: 3 Review CommentsOverviewThe Global Summary Of The Day dataset contains weather data collected from meteorological stations all over the planet. However, accessing and formatting this data for use in R can be rather tricky. The GSODR R package will make this a dream. This package will be incredibly useful for new R users who want easy access to this data set. It will also be useful for experienced R users who want to download data over large extents and do post-processing later in R. I very much look forward to using this package in the future. I have several major concerns before I can recommend this package for release. First, the main function Major issues
Minor issues
Typographic and stylistic issues
|
This comment has been minimized.
This comment has been minimized.
Thanks, Jeff. I'm rather embarrassed that it didn't work for you. I'll see what needs to be done to get it fixed and report back here when/as I do. |
This comment has been minimized.
This comment has been minimized.
thanks for the review @jeffreyhanson ! a few notes:
|
This comment has been minimized.
This comment has been minimized.
2nd reviewer @deniederhut assigned |
This comment has been minimized.
This comment has been minimized.
jeffreyhanson
commented
Oct 21, 2016
@sckott Ok, thanks for correcting me on that. I just did a quick check and the |
This comment has been minimized.
This comment has been minimized.
@jeffreyhanson, I've fixed the bug with the country request in the devel branch. Good catch, THANK YOU! Your comment about the I'll work on some of the other issue's you've raised while I wait on my plane now. |
This comment has been minimized.
This comment has been minimized.
Add threads option to Fix Documentation contains '<' which is not rendered … Replace pattern call on line 292 … Fix bug when ISO2c/ISO3c is set, query fails Thanks, @jeffreyhanson, boarding now. |
This comment has been minimized.
This comment has been minimized.
Update authors in paper.md |
This comment has been minimized.
This comment has been minimized.
Edit code for clarity
|
This comment has been minimized.
This comment has been minimized.
Check and reset original options()
|
This comment has been minimized.
This comment has been minimized.
Renamed vignette to "GSODR" Additionally, @jeffreyhanson, If you install from github using devtools, |
This comment has been minimized.
This comment has been minimized.
Added GSODR.R to create helpfile for package
|
This comment has been minimized.
This comment has been minimized.
Removed
|
This comment has been minimized.
This comment has been minimized.
Update. I've made a minor change to the package that does not affect the functionality. Due to the size of the initially added climate data and the addition of yet more data by myself just this week, the package size was 5.1Mb. I've moved the additional climate data to its own R package that's available only from GitHub, https://github.com/adamhsparks/GSODR.data. This is referenced in the README and a vignette. |
This comment has been minimized.
This comment has been minimized.
okay, you do plan to put it on CRAN though since I imagine this will go to CRAN. |
This comment has been minimized.
This comment has been minimized.
GSODR is on CRAN and I'll update it once this review is done. The other package, GSODR.data is too large for CRAN unless it's split into two packages or I remove some of the data sets. I'm happy to just leave it on GitHub since it's not essential for the use of GSODR. Thoughts? |
This comment has been minimized.
This comment has been minimized.
Ah, if not required for GSODR, then all good, |
This comment has been minimized.
This comment has been minimized.
I guess maybe I wasn't initially clear. It's four sources of climate data that are formatted for use with the data GSODR provides. You can link these data to GSOD data by station ID and LAT/LON. I have one example in a vignette using a one of the data sets, but for normal use it's not required. It just makes this data more available for use with GSOD data output produced by GSODR. So since it's mentioned in a vignette, does that require a CRAN version? edit I could put just the dataset that's referenced in the GSODR package itself and leave the other three as the optional download from GitHub. Is that a good option? |
This comment has been minimized.
This comment has been minimized.
deniederhut
commented
Jan 7, 2017
Okay, vignettes look good! I think I would still like to see some explicit correctness check in the unit tests somewhere, perhaps with a cached result, but I am recommending this package for approval. A few bugs I ran into while testing:
|
This comment has been minimized.
This comment has been minimized.
Thanks, I have fixed # 3 easily. The other two I'm not so sure of, I've never run into either one with all my testing.
|
This comment has been minimized.
This comment has been minimized.
jeffreyhanson
commented
Jan 8, 2017
Hi, thanks for the reminder. I'll take a look at this sometime this coming week. |
This comment has been minimized.
This comment has been minimized.
its possible you have @deniederhut |
This comment has been minimized.
This comment has been minimized.
this is solved by restarting R usually |
This comment has been minimized.
This comment has been minimized.
thanks @jeffreyhanson |
This comment has been minimized.
This comment has been minimized.
@sckott, I've added the minimum version of purrr to DESCRIPTION. Thanks for the tip. |
This comment has been minimized.
This comment has been minimized.
jeffreyhanson
commented
Jan 13, 2017
I'm still on holiday in New Zealand and won't be back till the 18th. I was hoping that the local library's internet would be good enough to let me test the package, but that doesn't seem to be the case. Would you mind if I submitted my review when I'm back home? Also, I noticed that the DESCRIPTION is missing a Maintainer field. |
This comment has been minimized.
This comment has been minimized.
@jeffreyhanson,
|
This comment has been minimized.
This comment has been minimized.
jeffreyhanson
commented
Jan 18, 2017
@adamhsparks Ok, sounds good. |
This comment has been minimized.
This comment has been minimized.
jeffreyhanson
commented
Jan 18, 2017
Overall, I am very impressed with this package. I think it will make a great addition to rOpenSci's
Test environment
PS. Thank you for introducing me to the .gpkg format. It looks much easier to work with than ESRI Shapefiles for vector data. |
This comment has been minimized.
This comment has been minimized.
Hi @jeffreyhanson, RE 2. Right now I'm checking on your GPKG error. I've set up a fresh R install on an ElementaryOS VM (based on Xenial) and installed GSODR on that. With a fresh installation, I'm able to create a GPKG file and I have the same version of rgdal that you do, 1.2-5, though I did add a minimum version to the DESCRIPTION, >= 1.1-9, so I don't think that's the issue and I don't think I'm missing dependencies since it works for me on a fresh install. What does |
This comment has been minimized.
This comment has been minimized.
jeffreyhanson
commented
Jan 18, 2017
Here's the output. It looks like it's an issue with my GDAL installation, so feel free to disregard the issue.
|
This comment has been minimized.
This comment has been minimized.
@jeffreyhanson, |
This comment has been minimized.
This comment has been minimized.
thanks @jeffreyhanson for taking another look @adamhsparks looks like we're good to go then since looks like you dealt with that |
This comment has been minimized.
This comment has been minimized.
@sckott I think we're good. I was waiting to check the results of Appveyor and Travis this morning when I woke up and see if everything was good as far as the I added another test related to the file saving parameters this morning based on a bug I found last night. Everything looks good on winbuilder now as well. I'm ready to go if you are. |
sckott
added
6/approved
and removed
5/awaiting-reviewer(s)-response
labels
Jan 18, 2017
This comment has been minimized.
This comment has been minimized.
Approved
I'll get back to you soon on the JOSS stuff in a bit |
This comment has been minimized.
This comment has been minimized.
deniederhut
commented
Jan 19, 2017
Congrats @adamhsparks !! |
This comment has been minimized.
This comment has been minimized.
@sckott now that the dust is settling and I've moved everything over, I'm happy to do a short-form blog post. |
This comment has been minimized.
This comment has been minimized.
@adamhsparks great, on the blog post: We'll send an email to get that started on JOSS: I saw that you did a new release, what is the Zenodo DOI for that? You can submit to https://github.com/openjournals/joss-reviews/issues now |
sckott
closed this
Jan 20, 2017
This comment has been minimized.
This comment has been minimized.
@adamhsparks blarg, sorry, meant to give you https links for the footer image, plz change to |
adamhsparks commentedOct 14, 2016
•
edited
Summary
The GSODR package offers an R interface for downloading Global Surface
Summary of the Day weather data files from the United States National Climatic
Data Center, applies rules for cleaning and parses them into files useful for
researchers.
https://github.com/adamhsparks/GSODR
Researchers who use daily weather data. Most individuals I've encountered so far
are crop or plant disease modellers, hydrological modellers, etc. However,
I'm there that there are others that I'm just unaware of due to my work-sphere.
gsod: obtain daily weather data" from Jacob Van Etten, 2013
This package was written for a instructional course and has not been submitted
to CRAN or updated in some time. It does offer the same corrected elevation that
GSODR offers, however the station list is not updated from the NCDC server,
meaning that the station list provided with this package is over two years old.
It is part of a crop modelling course, not designed to only download and clean
GSOD data. GSODR also offers different types of file outputs, Geopackage or
comma-separated values (CSV).
GSODTools: R functions to select, download, and process GSOD data
This package is well written and maintained on GitHub only. The package is not
available on CRAN at this date, either. It offers many of the same functions as
GSODR. However, it does not automatically convert the values to International
System of Units (SI), which GSODR does. It also does not offer the corrected
elevation values that GSODR offers. Florian indicated that this project was
not top priority during the completion of his PhD but was happy to consider
working together in the future.
rnoaa: R interface to many NOAA data APIs
This package offers an interface to several of NOAA's weather data sets. However,
GSOD is not among the data sets that are available through this package.
Requirements
Confirm each of the following by checking the box. This package:
Publication options
paper.md
with a high-level description in the package root or ininst/
.Detail
R CMD check
(ordevtools::check()
) succeed? Paste and describe any errors or warnings:Scott Chamberlain, https://github.com/sckott
Brooke Anderson, https://github.com/geanders
Florian Detsch, https://github.com/fdetsch
Jeff Hansen, https://github.com/jeffreyhanson