Closed mskyttner closed 2 years ago
Hello @mskyttner, thanks for the submission. Before proceeding, the Editors have some questions for you.
We are not sure whether this package helps access data or distributes data. There is the impression the authors pre-prepared some dataset from the website they mention.
Are there no other more dynamic ways to get the data? Especially as in the future their prepared dataset might get stale.
Also, some editors had troubles accessing aquamaps.org, as they got a security alert. Can you double-check that the provided link is correct?
Hello @melvidoni,
Thank you for the detailed response @mskyttner. Could you please clarify who updates the "compressed archive variant in SQLite format that gets downloaded from archive.org" and how often it is done?
Yes @melvidoni, this is done by AquaMaps staff using the "data management" functions in the package and scripts like those in data-raw, a workflow which they have requested I developed support for in the package, in order to be able to do those updates more frequently, when data is changed or appended at the source. Historically the update frequency has been sporadic, with yearly updates being the goal. I have developed the package on basis of input from the AquaMaps team and will ask the staff there what their planned update frequency is and report back here going forward. Also, the database structure in the export / data distribution is "cleaned up" with regards to field names, scope/filters in order to be able to distribute the relevant data using a new more easily automatable workflow. I believe API support for delivering more up-to-date data has been discussed at AquaMaps but I'm not fully aware of the current plans for that.
Thanks for the clarifications. @maurolepore will be the Handling Editor. He will be performing the editors' checks soon.
@mskyttner thanks for your submission! It's my pleasure to be the handling editor.
Here are my editor checks (guidelines). I'll start exploring potential reviewers but I would like to assign them only after you meet or justify against my requests (see section "Requests" below). This is to ensure the reviewers focus in the most interesting aspects of your work, and ultimately to help you maximize the quality of your package. Let me know when you are ready.
I also added a section "Observations". This is to support my requests and to guide you in finding a solution or argument against my requests.
Please let me know if you have any question or concern.
FIT AND OVERLAP
[ ] If still relevant, please also argue explicitly how this package fits in the category “geospatial data”.
[ ] Please refer to the guidelines and discuss the potential overlap with other packages.
INSTALLATION
gpg
? If so, please add it to DESCRIPTION.INTEGRITY
[ ] Does DESCRIPTION need “rgdal” to include under Imports or Suggests?
[ ] Please address (or justify against) the recommendations of goodpractice::gp()
.
METADATA
[ ] Please fix problematic URLs in README and DESCRIPTION.
[ ] Please review possibly misspelled words.
TESTS
CI
STYLE
styler::style_pkg()
and usethis::use_tidy_description()
.FIT AND OVERLAP
Here I see an argument for how the package fits in “data retrieval” but not in “geospatial data”.
In README I see “A similar package which also provides the aquamaps algorithm is available at https://github.com/raquamaps/raquamaps”; but overlap is not discussed here.
INSTALLATION
Local install on my personal computer and personal library succeeds.
Local install on a container from rocker/verse fails with:
install(dependencies = TRUE, build_vignettes = TRUE)
Error: package or namespace load failed for ‘rcrypt’:
.onLoad failed in loadNamespace() for 'rcrypt', details:
call: fun(libname, pkgname)
error: Please install GPG first or check if GPG can be run from the command line.
The rcrypt package is just an interface to GPG. See https://gnupg.org/ for
installation guidelines.
INTEGRITY
devtools::check()
failed with a message suggesting a vignette needs it, and it seems to not install with the package.
Also I experienced problems with codetools, but it might be a an odd problem specific to my system.
Error in .doLoadActions(where, attach) :
error in load action .__A__.1 for package raster: loadModule(module = "spmod", what = TRUE, env = ns, loadNow = TRUE): Unable to load module "spmod": package ‘codetools’ was installed before R 4.0.0: please re-install it
Calls: <Anonymous> ... asNamespace -> loadNamespace -> <Anonymous> -> .doLoadActions
Execution halted
devtools::test()
#> Loading aquamapsdata
#>
#> _. _. _. ._ _ _. ._ _ _| _. _|_ _.
#> (_| (_| |_| (_| | | | (_| |_) _> (_| (_| |_ (_|
#> | |
#> Testing aquamapsdata
#> ✓ | OK F W S | Context
#> ⠏ | 0 | csquare ⠏ | 0 | Csquare Conversions ✓ | 12 | Csquare Conversions
#> ⠏ | 0 | name_search ⠏ | 0 | Name Search ⠧ | 8 | Name Search ✓ | 9 | Name Search [0.1 s]
#>
#> ══ Results ═════════════════════════════════════════════════════════════════════
#> Duration: 0.2 s
#>
#> [ FAIL 0 | WARN 0 | SKIP 0 | PASS 21 ]
METADATA
> urlchecker::url_check()
! Warning: README.md:84:19 Moved
Unported License](http://creativecommons.org/licenses/by-nc/3.0/):
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
https://creativecommons.org/licenses/by-nc/3.0/
x Error: README.md:32:2 Error: SSL: no alternative certificate subject name matches target host name 'aquamaps.org'
<https://aquamaps.org>, but the `aquamapsdata` package offers an a
^~~~~~~~~~~~~~~~~~~~
x Error: README.md:71:43 Error: SSL: no alternative certificate subject name matches target host name 'aquamaps.org'
`aquamapsdata` provides data output from <https://aquamaps.org>; when
^~~~~~~~~~~~~~~~~~~~
x Error: man/am_meta.Rd:18:7 Error: SSL: no alternative certificate subject name matches target host name 'aquamaps.org'
\href{https://aquamaps.org/}{AquaMaps}
^~~~~~~~~~~~~~~~~~~~~
SPELLCHECK
TESTS
In some files test coverage is far under 80%.
covr::package_coverage()
#> aquamapsdata Coverage: 25.90%
#> R/aquamapsdata-package.R: 0.00%
#> R/download.R: 0.00%
#> R/spatial.R: 0.00%
#> R/db.R: 5.17%
#> R/data.R: 30.10%
#> R/csquare.R: 97.92%
#> R/zzz.R: 100.00%
CI
The continuous integration workflow for GitHub Actions runs R CMD check on only on ubuntu-20.04 and R-release.
The continuous integration configuration on Travis also seems to check the package with only one platform.
STYLE
styler::style_pkg()
changes most files and detects one syntax error:> styler::style_pkg()
Styling 20 files:
R/aquamapsdata-package.R ℹ
R/csquare.R ℹ
R/data.R ℹ
R/db.R ℹ
R/download.R ℹ
R/pipe.R ✓
R/spatial.R ℹ
R/utils.R ℹ
R/zzz.R ℹ
tests/testthat.R ✓
tests/testthat/test_csquare.R ℹ
tests/testthat/test_name_search.R ℹ
data-raw/am_meta.R ℹ
data-raw/am_minify_db.R ℹ
data-raw/am_search_boilerplate.R ℹ
data-raw/am_slice_db.R ℹ
data-raw/am_upload_ia.R !
data-raw/convert_csvs_to_db.R ℹ
data-raw/head_hundred.R ℹ
data-raw/onboarding_dev.R ℹ
────────────────────────────────────────
Status Count Legend
✓ 2 File unchanged.
ℹ 17 File changed.
x 1 Styling threw an error.
────────────────────────────────────────
Please review the changes carefully!
Warning message:
When processing data-raw/am_upload_ia.R: <text>:1:8: unexpected '{'
1: dontrun{
^
@mskyttner, could you please add the rOpenSci under review badge to your README?
You may use rodev::use_review_badge()
, rodev::use_review_badge(<issue_number>)
. Badge URL is https://badges.ropensci.org/<issue_id>_status.svg
.
Full link should be:
[![](https://badges.ropensci.org/<issue_id>_status.svg)](https://github.com/ropensci/software-review/issues/<issue_id>)
--
Reviewers:
Due date:
Thanks @maurolepore for the feedback! I'm breaking those requests/items up into steps/issues now and will ping back once ready.
Hi @mskyttner, just checking how you are going. What would be your estimated time to address the items I mentioned above? There is no rush. I only ask to see if in the meantime I can help with other submissions.
Hi @maurolepore thanks for checking up on me, I have been off for a while due to some health issues with my elderly parents but getting back now. I have about half of the editor check issues raised adressed (I think) here https://github.com/raquamaps/aquamapsdata/pull/32 but probably need another week to work through the CI / test coverage / style. I tried to use a rocker/geospatial base image rather than rocker/tidyverse base in the CI setup due to some issues with rgdal installation etc, still struggling a bit with getting that sorted out for all the platforms and versions of R etc. Will try to look more in depth at links with examples how this can be set up ^^.
Thanks for letting me know. I'm sorry to hear that. I'll apply the "holding" label and try help elsewhere. Let me know when you are ready.
@mskyttner, just touching base. Are you okay staying on hold?
@mskyttner I really hope you and your family are well. I realize I touched base a bit too early. The first revision of the 'holding' label will formally be on May 22.
The holding status will be revisited every 3 months, and after one year the issue will be closed. --https://devdevguide.netlify.app/policies.html#policiesreviewprocess
Hi @mskyttner, it's about the time when we should review the "holding" status. Shall we keep it or are you ready to resume work on this submission?
--
The author can choose to have their submission put on hold (editor applies the holding label). The holding status will be revisited every 3 months, and after one year the issue will be closed. -- -- https://devdevguide.netlify.app/policies.html#policiesreviewprocess
Hi @mskyttner ! We are doing a sweep of stale review issues. Since this review has been open and inactive for so long, much may have changed including author, editor, and reviewer bandwidth and ever-evolving rOpenSci best practices. As such, I'm closing this issue. If you still have interest and capacity, we would welcome you to open a new submission issue!
Submitting Author Name: Markus Skyttner Submitting Author Github Handle: !--author1-->@mskyttner<!--end-author1-- Repository: https://github.com/raquamaps/aquamapsdata Version submitted: 0.1.6 Editor: @maurolepore Reviewers: TBD
Archive: TBD Version accepted: TBD --- - Paste the full DESCRIPTION file inside a code block below: ``` Package: aquamapsdata Type: Package Title: Curated Data From AquaMaps.Org Date: 2020-11-21 Version: 0.1.6 Authors@R: c( person("Markus", "Skyttner", email = "markus.skyttner@nrm.se", role = c("aut", "cre")), person("Christina", "Garilao", role = c("ctb"))) Maintainer: Markus SkyttnerMEE Options
- [ ] The package is novel and will be of interest to the broad readership of the journal. - [ ] The manuscript describing the package is no longer than 3000 words. - [ ] You intend to archive the code for the package in a long-term repository which meets the requirements of the journal (see [MEE's Policy on Publishing Code](http://besjournals.onlinelibrary.wiley.com/hub/journal/10.1111/(ISSN)2041-210X/journal-resources/policy-on-publishing-code.html)) - (*Scope: Do consider MEE's [Aims and Scope](http://besjournals.onlinelibrary.wiley.com/hub/journal/10.1111/(ISSN)2041-210X/aims-and-scope/read-full-aims-and-scope.html) for your manuscript. We make no guarantee that your manuscript will be within MEE scope.*) - (*Although not required, we strongly recommend having a full manuscript prepared when you submit here.*) - (*Please do not submit your package separately to Methods in Ecology and Evolution*)