-
-
Notifications
You must be signed in to change notification settings - Fork 36
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
[REVIEW]: Sentiment Analysis of Twitter Data (SAoTD) #764
Comments
Hello human, I'm @whedon. I'm here to help you with some common editorial tasks. @kbenoit it looks like you're currently assigned as the reviewer for this paper 🎉. ⭐ Important ⭐ If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews 😿 To fix this do the following two things:
For a list of things I can do to help you, just type:
|
|
Review[Checklist moved above] CommentsOn the paperThis paper describes an R package that provides a workflow for analyzing sentiment and topics in Twitter text, wrapping around packages such as twitteR, tidytext, and topicmodels. The package contains a number of useful analytic functions for looking at Twitter data, and these are clearly demonstrated in the vignette. Some of these could be useful to other forms of text, but the package is specially designed to work with Twitter data, including not just the import of this data but also working with Twitter-specific handles such as hashtags and usernames This paper makes a nice, short article that should be published, but could be improved by addressing a few relatively minor issues:
On the packageThe package works, and I have seen much worse source code in widely-used R packages published on CRAN. These are some suggestions for improving the code and the package, not necessarily linked to the paper and whether it should be published. (I leave to the editor to decide.) Naming. This is a matter of preference, although there are some emerging guidelines designed to reduce the chaos in the R world. This paper combines capitalized object names with lower-cased object names, and function names with The package name itself runs contrary to this advice from Hadley Wickham:
Unnecessary C++ code. Why is there a function Data copyright issues. Can distribute the data in Data object loading. Set (non-)Object orientation. None of the functions use generics and method dispatch, but rather check the class of the input objects using conditionals within each function (e.g. here. This makes extending the package harder, in addition to being more error-prone. The function names are very generic, furthermore, such as Code organization. Nearly all functions are in a single long .R file called Examples. Most examples are not run, due to the difficulties of connecting to the Twitter API using authentication. But this is not true for an functions that only use Tests. The file |
Excellent review, @kbenoit! Thank so much! @evan-l-munson Can you address the issues raised in the review - particularly the missing checked items from the review checklist and the other useful suggestions raised in the review? |
Thank you for the review.
I will work on those notes/corrections as soon as I get a chance (just moved my family across the United States and started a new job).
Evan Munson
…Sent from my iPhone
On Jun 7, 2018, at 01:15, Thomas J. Leeper ***@***.***> wrote:
Excellent review, @kbenoit! Thank so much!
@evan-l-munson Can you address the issues raised in the review - particularly the missing checked items from the review checklist and the other useful suggestions raised in the review?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.
|
@evan-l-munson Just a nudge on this. |
@evan-l-munson Just another nudge on this. |
Thank you for the reminder. I have not forgotten.
…Sent from my iPhone
On Aug 26, 2018, at 16:05, Thomas J. Leeper ***@***.***> wrote:
@evan-l-munson Just another nudge on this.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.
|
Hi @evan-l-munson - please try and get to these updates when you get a chance. |
I have made about half the corrections suggested above. In the next week, I hope to rename my functions to better fit with standard naming conventions, additionally, I am looking at the test dataset for the copyright issues and a couple of the other issues. |
Good evening @arfon, I think I made all the requested corrections. Please let me know if you need anything else corrected/adjusted. Thanks for the patience and assistance in this process. |
👋 @kbenoit - please come and take another look at this submission when you get a chance, the author has made some updates based on your feedback. |
@arfon Happy to do so. |
Hi @kbenoit - have you had a chance to take another look at this submission? |
I've had a chance to look at the package again, and I am pleased to report that it and the paper are much improved. @evan-l-munson has done a very good job of addressing my concerns above, if not as good a job of summarizing in a PR or memo what these changes were 😉 . Package. The code organization is much better (and will be easier to maintain or for potential contributors to absorb). I also like the function naming much better than before - the function index looks more tidy and sensible now. There is still unnecessary C++ code in Paper. The paper does a much better job now of explaining the package and its purpose, and the vignette rounds this out nicely. Subject to the Hello World change, 👍. |
Thanks @kbenoit. @evan-l-munson - please make these final changes to your package and we can move forward accepting this submission. |
Gentlemen, I missed your email by accident. I appreciate these comments and will try to get them corrected/accounted for this weekend or sometime during the holidays. Thank you! |
Gentlemen, good morning. I have corrected rcpp_hello_world() function. I was running through everything to make sure it was working properly before I gave you the final word. Everything was looking good until I tried to view the vignette. For some reason, the vignette is not found when using utils::vignette("saotd"). I will troubleshoot that and hopefully get that working. Thanks! |
Thanks for the update @evan-l-munson |
👋 @evan-l-munson — How is it going? Have you been able to troubleshoot the issue? Give us an update when you can. Thanks! |
Good morning, I appreciate your patience with me. Finishing up this package is ending up being more challenging and time-consuming than I anticipated. I was working on my vignette issue yesterday and am struggling to fix what I am seeing. Everything seems to be built properly, however, after I re-download and load the package from my Git page the vignettes are not found. I have used both, |
I'm not sure sorry. Perhaps @kbenoit has some thoughts on this? |
@arfon I have another colleague looking into the issue for me. I am hoping they will get back to me this week. I have ran out of ideas on my end and am not sure why I can view the vignettes after I re-download the package from GitHub. If the vignette issue isn't a big one I would say the package is ready for submission, but if that is a big issue, I will continue to work on it. Thanks! |
Hi @evan-l-munson. I've made some slight tweaks to your paper in evan-l-munson/saotd#9 - let me know what you think. In addition, please make sure you:
|
@arfon, Good evening. I have completed your suggested edits/additions and pushed to GitHub. If there is anything else, let me know and I will get working on it asap. Thanks for the help! |
@whedon generate pdf |
|
@evan-l-munson thanks. Please could you clarify what version the package is now at? Given the modifications during the review it would seem appropriate to make a new release and archive in Zenodo. Once you've done this I'm happy to proceed with accepting this submission. |
@arfon, I bumped the package to version 0.2.0. I will work to get resubmit to Zendo within the next day or two. Will let you know when I get that done. Thanks! |
@arfon, I released the 0.2.0 version to zenodo this morning and have updated the DOI badge. Is there anything else you need? Thanks! |
@whedon set 10.5281/zenodo.2578973 as archive |
OK. 10.5281/zenodo.2578973 is the archive. |
@whedon set 0.2.0 as version |
OK. 0.2.0 is the version. |
@whedon accept |
|
|
Check final proof 👉 openjournals/joss-papers#529 If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#529, then you can now move forward with accepting the submission by compiling again with the flag
|
@whedon accept deposit=true |
|
🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨 Here's what you must now do:
Any issues? notify your editorial technical team... |
🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉 If you would like to include a link to your paper from your README use the following code snippets:
This is how it will look in your documentation: We need your help! Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:
|
@kbenoit - many thanks for your review of this submission ✨ @evan-l-munson - your paper is now accepted into JOSS ⚡🚀💥 |
🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉 If you would like to include a link to your paper from your README use the following code snippets:
This is how it will look in your documentation: We need your help! Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:
|
Submitting author: @evan-l-munson (Evan Munson)
Repository: https://github.com/evan-l-munson/SAoTD
Version: 0.2.0
Editor: @arfon
Reviewer: @kbenoit
Archive: 10.5281/zenodo.2578973
Status
Status badge code:
Reviewers and authors:
Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)
Reviewer instructions & questions
@kbenoit, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:
The reviewer guidelines are available here: https://joss.theoj.org/about#reviewer_guidelines. Any questions/concerns please let @leeper know.
Review checklist for @kbenoit
Conflict of interest
Code of Conduct
General checks
No, but many R packages using standard licenses only name the license in the
DESCRIPTION
file. TheREADME.md
refers to "All code is licensed GL", this should be "GPL-x".No: GitHub release is 6 commits behind the master. Master has v1.0.0.
Yes, apparently all.
More than complete, as the 2nd through last author have an unknown contribution to the software. They have not made any GitHub commits, and there is no record of them having authored any of the functions (for instance via
@author
).Functionality
Documentation
Software paper
paper.md
file include a list of authors with their affiliations?No, the paper focuses more on what the package does than providing an explicit statement of need. This could be made more clear (and at little cost or effort).
The text was updated successfully, but these errors were encountered: