-
-
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: rromeo #285
Comments
thanks for your submission @Rekyt assigning an editor soon |
Editor checks:
Editor commentsThanks for your submission @Rekyt ! Here's the output from goodpractice. If you haven't used ── GP rromeo ───────
It is good practice to
✖ write unit tests for all functions, and all package code in general. 96% of code lines are covered by test
cases.
R/rromeo_publishers.R:199:NA
R/rromeo_publishers.R:200:NA
R/rromeo_publishers.R:202:NA
R/rromeo_publishers.R:265:NA
R/rromeo_publishers.R:267:NA
... and 3 more lines
✖ use '<-' for assignment instead of '='. '<-' is the standard, and R users and developers are used it and
it is easier to read your code for them if you use '<-'.
R/rromeo_base.R:3:13
R/rromeo_base.R:7:13
R/rromeo_base.R:20:16
R/rromeo_base.R:21:12
R/rromeo_journals.R:20:17
... and 119 more lines
✖ avoid long code lines, it is bad for readability. Also, many people prefer editor windows that are about
80 characters wide. Try make your lines shorter than 80 characters
R/utils.R:98:1 Seeking reviewers now 🕐 Could you please add the rOpenSci under review badge to your README?
Reviewers: |
reviewers assigned |
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: 6 Review CommentsFirst of all, When reviewing a package, I always start with the vignette. The vignette that comes along with Packaging guidelinesWhy I did not tick off
Miscellaneous
UsageI run the examples from the vignette and worked through the package this way. Here a few things I want to address explicitly:
ConclusionAs soon as the author has improved the output of Nevertheless, I hope that I could provide some helpful input on the package, especially from a user's sight. Regarding my quite specific "change requests" #1 and #2, I'm curious about the author's opinion. |
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 Comments
I opened the source code in the function and found that my current configuration was:
This error was probably generated by the lack of an
Q: Does the code comply with general principles in the Mozilla reviewing guide? Q: Does the package comply with the rOpenSci packaging guide? Q: Are there improvements that could be made to the code style? Q: Is there code duplication in the package that should be reduced? Q: Are there user interface improvements that could be made? Q: Are there performance improvements that could be made? Q: Is the documentation (installation instructions/vignettes/examples/demos) clear and sufficient? Does it use the principle of multiple points of entry i.e. takes into account the fact that any piece of documentation may be the first encounter the user has with the package and/or the tool/data it wraps? A: Yes. Q: Were functions and arguments named to work together to form a common, logical programming API that is easy to read, and autocomplete? A: Yes. Conclusion
(thanks for the reminder, @sckott!) |
thanks for your review @brunaw all reviews in |
We would like to thank @ottlngr and @brunaw for the time they took reviewing As noted by both reviewers and the editor @sckott, We'll first respond to @ottlngr comments:
We hadn't thought of adding a user-agent which is good practice and we thank @ottlngr for this great suggestion now implemented in ropensci-archive/rromeo@3b2afd5
For development reasons we still want to keep a We also now created an
There was a missing
This was a very useful suggestion and the package now has two separate functions: Instead of a warning, there is now a message suggesting the usage of
There was an error in the Regarding @brunaw comments:
We now specify better the target audience of the package in the beginning of the README file. ropensci-archive/rromeo@c86dca8
As explained above the function now gives a message instead of a warning.
Thanks for this very nice suggestion! We now include a full vignette regarding the way to set up an API key ropensci-archive/rromeo@967322a to ropensci-archive/rromeo@b45f218 see addition with https://github.com/Rekyt/rromeo/compare/58fb140..b45f218
The function is now split between
We now systematically point to the API vignette to setup the API key.
Thank you for the detailed report of the error, it really helped to fix the bug. It is now fixed ropensci-archive/rromeo@59a7b40
We now include a CONTRIBUTING file. ropensci-archive/rromeo@78fbe2c
Thank you for this thoughtful comment, it greatly improved the readability of our internal functions ropensci-archive/rromeo@0990b6f and ropensci-archive/rromeo@526c502 We hope we managed to answer and take into account all the comments and we would like to thank again both reviewers @brunaw and @ottlngr as well as the editor @sckott for their useful comments and suggestions! |
For me, yes! I reinstalled and tested it, everything is checking. The improvements on the documentation are great as well. Thanks for the package @Rekyt! |
thanks @brunaw ! |
Great, thanks for the thumbs up reviewers. I'm taking a final look ... |
Approved! Thanks again for your submission @Rekyt ! And thanks for your reviews @ottlngr and @brunaw 👌 To-dos:
We've started putting together a bookdown with our best practice and tips, this chapter starts the 3d section that's about guidance for after onboarding. Please tell us what could be improved. The repo is at https://github.com/ropensci/dev_guide Are you interested in doing a blog post for our blog https://ropensci.org/blog/ ? either a short-form intro to it (https://ropensci.org/technotes/) or long-form post with more narrative about its development (https://ropensci.org/blog/). If so, we'll have our community manager @stefaniebutland get in touch with you on that |
@Rekyt @Bisaloo 😄 Great to hear you would like to contribute a post about rromeo. Here are examples of blog posts by authors of peer-reviewed packages so you can get an idea of the style and length you prefer: https://ropensci.org/tags/software-peer-review/. Tech Notes (shorter, focusing on a single example) are here: https://ropensci.org/technotes/. Here are some technical and editorial guidelines for contributing a post: https://github.com/ropensci/roweb2#contributing-a-blog-post. Please submit your draft post via pull request a week before the planned publication date so we can give you some feedback. Right now I have Tues May 21 or Tues June 4 available as publication dates. Happy to answer any questions. |
@Rekyt gave you admin access on the repo now |
Hi, we would like to thank @brunaw and @ottlngr for checking the package again and recommending it! @stefaniebutland, we would be interested in writing a regular blog post with the narrative about how we decided to build Many thanks! |
@stefaniebutland, yes, we have been working on a draft on our fork. It should be ready by tonight for a first look on your side! 🙏 We will submit a PR as soon as we can. |
Submitting Author: Matthias Grenié (@Rekyt)
Repository: https://github.com/Rekyt/rromeo
Version submitted: 0.1.0
Editor: @sckott
Reviewer 1: @ottlngr
Reviewer 2: @brunaw
Archive: TBD
Version accepted: TBD
Scope
Please indicate which category or categories from our package fit policies this package falls under: (Please check an appropriate box below. If you are unsure, we suggest you make a pre-submission inquiry.):
Explain how and why the package falls under these categories (briefly, 1-2 sentences):
This package is an R wrapper to the SHERPA/RoMEO API available online. It provides direct access to the API through R functions.
Specifically bibliometricians interested in retrieving data on archival policies of different journals.
rromeo
can be use to draw a quick portrait of the archival policies of a given scientific field, or to show differences among publisher practices.To our knowledge there are no R packages providing access to this API.
#273
Technical checks
Confirm each of the following by checking the box. This package:
Publication options
JOSS Options
paper.md
matching JOSS's requirements with a high-level description in the package root or ininst/
.MEE Options
Code of conduct
The text was updated successfully, but these errors were encountered: