-
-
Notifications
You must be signed in to change notification settings - Fork 104
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
mregions: Marine Regions Data from Marineregions.org #53
Comments
Happy to review |
Actually I should withdraw since this is COI for me especially in the context of JOSS. Thanks for the ping @noamross |
Passes all editors' checks, seems like a good fit 😉 Seeking reviewers... |
Reviewers: @mdsumner Still seeking second reviewer |
CommentsThe The package is structured well using the modern approach with The package is easy to use and seems to do all the things that it's designed to do. I found it hard to see what the package is for overall, since the readme, vignette and documentation are all quite sparse and there's no overall "why this?" message. That may not matter if this is specifically for users of Marine Regions, but it seems there are a lot more potential users. I am very interested personally in how this fits in with the broader geo-spatial ecosystem in R, and will be happy to contribute in an ongoing way - unfortunately this is all I can give before the review deadline. (I had planned on pull requests for some suggestions, but travel plans mean I just can't get to those in time.) Thanks very much! InstallationThe package can be checked out and built easily in RStudio with devtools. It passes check on Windows and Debian, also passes check on devel on Windows. Specific comments on code
library(mregions)
rn <- region_names()
library(dplyr)
bind_rows(region_names_search("EEZ")) %>% select(title)
do.call(rbind, lapply(region_names(), as.data.frame, stringsAsFactors = FALSE))
This example results in all(?) possible records being queried. #' devtools::install_github("iobis/robis")
library('robis')
shp <- region_shp(name = "Belgian Exclusive Economic Zone")
## a rogue user decides to load a projected map somehow
shp <- sp::spTransform(shp, "+proj=laea +ellps=WGS84 +lon_0=2.5 +lat_0=51.6")
wkt <- as_wkt(shp)
## now we are in trouble...
xx <- occurrence("Abra alba", geometry = wkt)
## Retrieved 2000 records of 33188 (6%)
## ... Questions
ROpensci criteriaPackage name, Function and variable naming, Coding style, Code of Conduct, Testing, Package scaffolding, all good. ReadmeThe readme does not describe what the package is for, beyond "get data from ..." DocumentationThe documentation is very terse, functions do not have Details or Value slots, a few explicit sentences in each would help a lot
There is a vignette, but it's a little terse and some of the pre-amble is about installing and is not relevant afaics (move that to readme?).
ExamplesThese are good if a little terse in places. Console messagesThere aren't many of these, but I have not had time to explore in much detail. |
thanks a lot @mdsumner ! will make changes very soon |
responses to @mdsumner ---> links to issues opened in
Good point, i'll add some more why you should care bits to various places in the pkg docs (ropensci-archive/mregions#13)
Looking forward to any contributions!
Right, and WKT is a common geospatial data format, often used to store spatial data in databases, and a number of species occurrence databases expect WKT, including OBIS and the biggest one http://www.gbif.org/ - I'll include more reasoning for this (ropensci-archive/mregions#14)
Good idea, can have it accept either a string or the output of
I can add
true, i'll do that (ropensci-archive/mregions#17)
Please do contribute if you have time, if not, let me know and I'll try
it's probably controversial but I don't like vignettes building on package installation, no other languages do this, so i pre-render the vignette to markdown I just rembered that (ropensci-archive/mregions#18)
Good point, will add more info to readme about what it's for (ropensci-archive/mregions#13)
Thanks, will make improvements (ropensci-archive/mregions#19)
Good catch, i'll fix that (ropensci-archive/mregions#20)
Will do (ropensci-archive/mregions#21)
I'll improve the vignette (ropensci-archive/mregions#22)
good idea (ropensci-archive/mregions#23)
not sure what you mean, but I'll use different object names to avoid any confusion (ropensci-archive/mregions#24)
I just rembered that
Good point, I'll add more examples (ropensci-archive/mregions#25) |
anything else I should do @mdsumner ? |
Just a few comments in addition to @mdsumner's nice review. @mdsumner, let us know if @sckott has addressed your concerns to satisfaction.
I don't get this locally
|
nice, thanks @noamross
I'll look into that, thanks
right, a leaflet warning, i'll install on travis
don't know why either, can add that.
yeah, good thinking! ropensci-archive/mregions#28
i think so, so ?:
|
pretty much ready to go except there's a weird problem in the test suite only on CI seemingly related to |
Oops that's mine, I'll have a look. ast 13 lines of output: testthat resultsOK: 0 SKIPPED: 11 FAILED: 1
On Tue, 2 Aug 2016 at 08:55 Scott Chamberlain notifications@github.com
|
Hi, I'm satisfied that the issues from my review have been addressed. Good job! Cheers, Mike |
cool, now to go to CRAN |
thanks for your review @mdsumner ! |
mregions
is a wrapper to REST API methods from http://www.marineregions.org/ - with purpose of fetching marine regions in geojson/shp/wkt format for use downstream.https://github.com/ropenscilabs/mregions
REST API from http://www.marineregions.org/ and a geoserver API from a related service http://geo.vliz.be/geoserver/ows
Biologists/oceanographers/ecologists and anyone else wanting to overlay data, or clip data to, various defined marine regions
Not that I know of
R CMD check
(ordevtools::check()
) produce any errors or warnings? If so paste them below.The text was updated successfully, but these errors were encountered: