-
-
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
codemetar package #130
Comments
Thanks for your submission @cboettig ! 😸 Looking for reviewers now. I also have two comments about one vignette and one test below. Editor checks:
Editor comments
Reviewers: @toph-allen @annakrystalli |
@maelle what version of dplyr are you using? Re the cloned-repo test on Windows, the error I see on Appveyor comes from the |
Ill look on Sunday or Monday but maybe add 0.7.0 as minimal version in DESCRIPTION? For me the first error was bc of the file path, the beginning worked when omitting the / at the end but I'll look again in a few days and hopefully make a PR or suggestions. Windows user at your service! 😉 |
|
@annakrystalli @toph-allen Thanks a lot for accepting to review this package! Your reviews are due on the 2017-08-07. As a reminder here is a link to the reviewing guide and here is one to the review template. @cboettig you can be one of the first submitters to use test our new dynamic RO package status badge! You can add the following to your README.
|
@annakrystalli @toph-allen friendly reminder that your reviews are due on Monday, August the 7th. 😉 |
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: 15 (too long I know!) Review CommentsThis package provides functionality to easily create JSON-LD metadata files describing r packages according to agreed on code medata controlled vocabularies. The functions are lightweight, clean and have a lot of automation and quality control baked in from their ability to extract information from package documentation and online standardised resources. It is a great addition to rOpenSci and general movements towards both linked data and better curation, visibility and citability of software. Overall, the functions are smooth and easy to use. I think the most difficult part of the package is getting your head round the concepts. There is good build/installationNo problems on mac documentationAs mentioned above, here are some suggestions on how I feel the readme could be more informative and self contained: I would have loved a short background section in the intro that could include a few key definitions (which could then be used consistently throughout) and a touch of historical context: eg. (sorry this are probably rubbish definitions but hopefully you get the gist!) Definitions & jargon busting
Briefly explain the difference between the data types (ie json, codemeta json-ld, codemeta r list) so that users can be cognisant of them when using package. Describe how project is the convergence of a number of initiatives:
Once I got my head round the above, I felt I understood the purpose and the function of the package but without a short summary and information spread across various sources it took a little time. None of this is of course necessary, I took special interest in the project because it really ties in with all my key interests so I'm probably a special case. But I almost feel that understanding these concepts could lead to better data management in general and adoption of JSON-LD more widely and for broader purposes. Let's just say this package could act as a gateway drug to JSON-LD, it certainly has for me! function documentation
|
DOne! Have a great weekend all 🎉 And thanks for the feedback @maelle 👍 |
Thank you @annakrystalli for the awesome review, really well done! 😸 I hope these were enjoyable 15 hours! Have a nice week-end too! |
@maelle I’ve had a busy few weeks, and won’t be able to submit a review by Monday. I’ll be taking some time off this week, though, so I’ll have time to get it done by the following Monday at the latest. Is that ok? |
@toph-allen thanks for the update! No problem since @cboettig already has the other review 😊 new deadline August the 14th, have a nice less busy week until then! |
@maelle Thank you for being flexible! |
@toph-allen friendly reminder that your review is now due on Monday, August the 14th 😸 |
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: 3h Review CommentsSummaryThis package aims to make it easier to add linked metadata to R software projects, which is a really cool endeavor — lowering the barrier of entry to linked metadata means its broader adoption within scientific computing. The package does so mainly by parsing existing metadata specified in the R Specific CommentsI encountered an error when I first ran Running Going through the package’s documentation alongside the ROpenSci Packaging Guide’s Documentation section, I made the following observations:
The vignettes and README.md file are generally rich, and a great source for expanding a user’s understanding of the package’s purpose and potential use cases. However, for entirely novice users, a reference to some introductory material might be helpful (per the package’s previous review).
The package’s core functionality successfully executed when I tested it on a few different packages (i.e. The paper.md “References” section is currently empty. The file I’m not sure what the purpose of The exported functions The |
@maelle Here’s my review! Let me know if there’s anything that is unclear or should be changed. |
Thanks a lot for your great review @toph-allen! 😁 @cboettig now the two reviews are in! 😉 |
@annakrystalli @toph-allen A huge thanks for these immensely helpful reviews! It is such a treat to get this kind of detailed attention, and I particularly appreciate the efforts of you both to wrestle not only with implementation details but also with the larger concepts and how they are communicated. I love @annakrystalli's comment about being a gateway drug to json-ld, it certainly has been for me and several of the vignettes really began as (perhaps still are) my playground for learning json-ld and what we can do with it. I think software metadata is generally both familiar and simple/limited enough (but not trivially so) to make it a good intro into the larger ideas. Still working through the individual issues back in the codemetar repo and hope to have them done soon, but just wanted to chime in here while it is not too stale and say thanks! |
Ok, with apologies for the delay, all edits have now been addressed. I've tried to summarize changes in issues under an onboarding milestone, there are summaries issue for all of the changes made in response to Toph and Anna. Thanks again for all the help! |
Thanks, @cboettig! @toph-allen and @annakrystalli, please look over the changes and let us know if they address your concerns. If yes, just say so and check the appropriate boxes up on your review. If not, let us know that else @cboettig should follow up on. |
Hi all, super happy with @cboettig responses and have checked the appropriate boxes. An offical |
Thanks @annakrystalli! @toph-allen can you have a look at @cboettig's work and answers and give a 👍 / :-1:? Thanks a lot in advance. |
@maelle I’ll have comments shortly. Sorry for the delay. |
Awesome @toph-allen thanks a lot in advance 😸 |
I'm sorry for the delay on this. I've looked through @cboettig's response, plus relevant updates to code & documentation, and it all looks great. I give a hearty 👍. @cboettig, I really appreciate the specific & detailed responses. I'm happy to have been a part of the review process. Please let me know if there is anything else needed from me to proceed! |
[I'm wrapping this up as @maelle is on vacation] Thank you for your follow-ups @toph-allen and @annakrystalli! @cboettig, a few last things I am finding in final checks. I'll accept pending these changes:
Fix these and we can move on to onboarding. Here's the checklist for after: To-dos:
|
@noamross Thanks! Looks like Shall I go ahead and do the transfer and those subsequent steps now? |
Ah, I am using development devtools. Disregard. Yes, transfer, but please do fix the text in the vignette first. |
@noamross thanks! Okay, I htink I've fixed that first vignette now as well (ropensci/codemetar@57caa46). Transferring now. |
Approved! Thanks @toph-allen and @annakrystalli for your reviews and @cboettig for your work. |
travis and codecov seem to be good, appveyor is tied to users, not github accounts, so you can add to yours Carl, I also just added to mine if you want to work off that one https://ci.appveyor.com/project/sckott/codemetar |
Seems the badge at https://github.com/ropensci/codemetar still says "Under Review", but the badge at https://ropensci.github.io/codemetar/ says "Peer Reviewed" (at least for me). Looks like a caching issue -- can we change the expiration time on the badge for the browser cache? |
Pinging @karthik. I think we finally fixed the issue of github caching the badges, but I guess this is another header variable to change for browser cache? (I see "peer reviewed" everywhere, myself) |
@cboettig you haven't submitted the package to JOSS yet, have you? |
@maelle no, thanks for the ping, I'll try that now. anything special I need to do re connecting to the rOpenSci review? |
okay, I believe I've initiated submission with http://joss.theoj.org/papers/b16b968425f513da31632b0edd8ff0c5. |
Perfect, I'll watch the new submissions at JOSS to comment in the Github issue right away to be sure it's flagged as rOpenSci-reviewed. |
Closing this since everything is going well over at JOSS! |
Summary
Codemeta defines a 'JSON-LD' format for describing software metadata.
This package provides utilities to generate, parse, and modify codemeta.jsonld
files automatically for R packages.
URL for the package (the development repository, not a stylized html page): https://github.com/codemeta/codemetar
Please indicate which category or categories from our package fit policies this package falls under *and why(? (e.g., data retrieval, reproducibility. If you are unsure, we suggest you make a pre-submission inquiry.):
Package for creating and working with scientific software metadata
Academic researchers looking to create metadata for their software
yours differ or meet our criteria for best-in-category?
Nope
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
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:
A few lines of code handle exceptional cases that are difficult to cover in unit tests. Otherwise no there should be no outstanding
goodpractice
flags in the repo.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:
Perhaps anyone interested in metadata/archiving or just in messing around with json, maybe:
@amoeba @gothub @jennybc @sckott @stephlocke @jeroen @mfenner @o2r-project
The text was updated successfully, but these errors were encountered: