-
-
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
submission: rppo #207
Comments
Editor checks:
Editor commentsHello @jdeck88, sorry for the slight delay and many thanks for your submission! An interesting package. So there's a few issues flagged by the initial editol checks:
|
Thank you for the comments Anna.. |
Thanks for your prompt response @jdeck88! I've found the first reviewer and just trying to secure the second one. Will keep you posted. 👍 |
@annakrystalli I'm just getting onto the review now, apologies for the delay. I'm aiming to get it done over this weekend. |
Hi @annakrystalli and @jdeck88, here's my review (apologies for the slight delay). Package Review
DocumentationThe package includes all the following forms of documentation:
Functionality
Estimated hours spent reviewing: 4 Review CommentsThe Rppo package allows programmatic access to the global Plant Phenology (PPO) data portal. This is a compact but well put together package that will come useful to many plant ecologists and evolutionary biologists. Note that although both DocumentationI have had difficulties with accessing the rppo vignette from R. This is the relevant devtools::check() output:
Similarly, browseVignettes() fails to find the document.
For now I haven't checked the vignette box in the checklist but will do as soon as this is resolved. In terms of content, the vignette could include a more fleshed out example of how the two functions can be combined to produce additional insights. I imagine they will often be used together? Functions
On a couple of occasions I have also received this message trying to run the example in the
Tests
A lone typo (well done!) found by I hope this is useful, thank you very much for your work on this! |
Likewise, here's mine! 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:
Functionality
Final approval (post-review)
Estimated hours spent reviewing: 5 Review Commentsrppo provides a method of accessing a web data portal to query records of plant phenology observations from North America and Europe. It will be of use to scientists who wish to access global data on plant phenology. While the package is simple to use, it would benefit from amendments to its documentation to clarify its purpose and usage. In particular:
I have detailed below a few further points with reference to the ROpenSci package guidelines. README
DESCRIPTION
Do you need to depend on this particular patchlevel?
DOCUMENTATIONrppo
ppo_terms DescriptionI suggest keeping the description concise, e.g. "Retrieve terms from the Plant Phenology Ontology", and moving the rest of the information to a "Details" section. Fix typo: pouplates ppo_data DescriptionThis section should describe the function specifically. The paragraph provided is background information that could go in a "Details" section and/or in the package documentation. ArgumentstermID - suggest cross referencing ValueI suggest describing the return value explicitly, e.g.
Fix typo: resultset Vignette
NEWS
TESTINGppo_data
ppo_terms
EXAMPLESppo_data
PACKAGE DEPENDENCIES
SCAFFOLDING
CONSOLE MESSAGES
CRAN GOTCHAS
Coding style
Code duplicationNot applicable. User interface issuesShould the data component returned from Performance issuesNo performance issues noted. BUGS
|
@jdeck88 I had also forgotten to ask you to add the rOpenSci review badge to the README! 😬
|
Thank you for the reviews! I will go through these in the next week. |
Thank you for your reviews. They were very helpful! I have addressed your comments... In most cases i was able to make updates, which are listed under UPDATES below. In some cases i had comments or questions and i've listed these under QUESTIONS/COMMENTS. UPDATES: Reviewer @remsamp
Reviewer @tdjames1
QUESTIONS/COMMENTS: Reviewer @remsamp
Reviewer @tdjames1 :
|
Hi @jdeck88, thanks for the thorough response. The documentation is much improved and the vignette is more helpful now, I think. You could include a full reference to your paper in the vignette rather than just a link (see https://rmarkdown.rstudio.com/authoring_bibliographies_and_citations.html). Running
There still seems to be a typo in ppo_terms.R: line 8 "pouplates"; also I noticed a typo in the updated README.md: line 38 "reccomend". Regarding URLs in the description field of DESCRIPTION file:
I don't know how to address the issues regarding building vignettes, maybe @annakrystalli can advise? @annakrystalli: pending the few points above I'm satisfied that all issues have been addressed. Do I need to do anything further to sign this off? |
Responses inline and indicated in BOLD (with fixes committed to https://github.com/biocodellc/rppo) You could include a full reference to your paper in the vignette rather than just a link (see https://rmarkdown.rstudio.com/authoring_bibliographies_and_citations.html). I tried this and was able to render this in HTML but not in Markdown. I worked on this for awhile this afternoon but felt that a single reference in this simple vignette was not worth the effort to track down why the markdown version was not rendering properly so left the link Running goodpractice::gp() threw up a couple of further points that have popped up in things that have been changed. I'm flagging these up here as you may wish to address them before submitting to CRAN: ✖ use '<-' for assignment instead of '='. '<-' is the standard,
Fixed ✖ avoid sapply(), it is not type safe. It might return a Fixed
There still seems to be a typo in ppo_terms.R: line 8 "pouplates"; also I noticed a typo in the updated README.md: line 38 "reccomend". Fixed Regarding URLs in the description field of DESCRIPTION file: URLs should be enclosed in angle brackets, e.g. ‘https://www.r-project.org’: see also Specifying URLs. Ok, i figured that out |
Hi @jdeck88, apologies for the long time in getting back to you. I am happy with your responses to my initial comments, thank you! I can also confirm that the points raised by @tdjames1 have been addressed by your most recent commits. To note: browseVignettes("rppo") now works after installing the package from github with @annakrystalli: I am happy with the state the package has got to. Please do let me know if I need to do anything else. Thanks! |
Right, so that's a wrap! Thanks for all your work and input @tdjames1 & @remsamp! @jdeck88, there's just a few last housekeeping steps to finalise the review process:
Any further questions, let me know! |
👋 @jdeck88 I promise I'd transfer the repo and not keep it to myself! Sorry about the awkward worfklow. |
OK...
1. i tried transferring to ropensci and that, as i was warned may not work,
didn't work.
2. tried transferring to @maelle <https://github.com/maelle> but that
didn't work becasue the repo was under an organization
3. Then transferred to my personal github repo @jdeck88 and transferred to @
maelle <https://github.com/maelle> and that worked!!
I haven't updated the travis CI links as i'll wait for it to become live at
its final destination since it is moving around a bit right now.
I did though add the ropensci badge to the bottom of the readme.
John
…On Thu, May 31, 2018 at 8:36 AM, Maëlle Salmon ***@***.***> wrote:
👋 @jdeck88 <https://github.com/jdeck88> I promise I'd transfer the repo
and not keep it to myself! Sorry about the awkward worfklow.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#207 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/ABGdxX8XGMwieiWGsvxhuyTwjPALtvYYks5t4A3pgaJpZM4TCTAN>
.
--
John Deck
(541) 914-4739
|
@jdeck88 your repo is now in ropensci and I made you admin again 🎊 thanks for your trust 😉 |
Great @jdeck88! Thanks again for submitting. I hope you found the process constructive and congratulations on your newly minted rOpenSci package! 🙌 |
Thanks Anna... one last thing... is there something i need to change the badge from "in review" to "peer reviewed"? |
Figured this out... turns out i had the wrong issue # in the badge status img link (but the correct one for the hyperlink!) |
Summary
What does this package do? (explain in 50 words or less):
The global plant phenology data portal (PPO data portal) is an aggregation of plant phenological observations from USA-NPN, NEON, and PEP725 representing 20 million phenological observations from across North America and Europe. The PPO data portal utilizes the Plant Phenology Ontology to align phenological terms and measurements from the various databases. The rppo R package enables programmatic access to all data contained in the PPO data portal.
Paste the full DESCRIPTION file inside a code block below:
https://github.com/biocodellc/rppo/
This package fits under data retrieval since it is used in downloading/extracting data from the global plant phenology data portal.
The target audience are scientists researching plant phenology patterns, shifts of plant phenological patterns over time and space, climate change biologists, and biodiversity scientists looking for sources of plant observation data.
yours differ or meet our criteria for best-in-category?
There are no other R packages that we know of that do the same thing.
We enquired with @sckott and @karthik several weeks ago.
Requirements
Confirm each of the following by checking the box. This package:
Publication options
paper.md
matching JOSS's requirements with a high-level description in the package root or ininst/
.Detail
Does
R CMD check
(ordevtools::check()
) succeed? Paste and describe any errors or warnings:Does the package conform to rOpenSci packaging guidelines? Please describe any exceptions:
If this is a resubmission following rejection, please explain the change in circumstances:
If possible, please provide recommendations of reviewers - those with experience with similar packages and/or likely users of your package - and their GitHub user names:
The text was updated successfully, but these errors were encountered: