Submitting author: @xillig (Gillian Kant)
Repository: https://github.com/xillig/TTLocVis
Version: 1.0.4
Editor: @trallard
Reviewer: @sara-02 , @linuxscout, @aozorahime
Archive: 10.5281/zenodo.4133399
:warning: JOSS reduced service mode :warning:
Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.
Status badge code:
HTML: <a href="https://joss.theoj.org/papers/448cbcd790258531fd790d0225442c94"><img src="https://joss.theoj.org/papers/448cbcd790258531fd790d0225442c94/status.svg"></a>
Markdown: [](https://joss.theoj.org/papers/448cbcd790258531fd790d0225442c94)
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) by leaving comments 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.)
@sara-02 & @linuxscout & @aozorahime, 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.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @trallard know.
✨ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest ✨
Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @sara-02 , @linuxscout, @aozorahime it looks like you're currently assigned to review this paper :tada:.
:warning: JOSS reduced service mode :warning:
Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.
:star: Important :star:
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:
@whedon commands
For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:
@whedon generate pdf
Reference check summary:
OK DOIs
- None
MISSING DOIs
- https://doi.org/10.1145/2484028.2484166 may be missing for title: Improving LDA Topic Models for Microblogs via Tweet Pooling and Automatic Labeling
INVALID DOIs
- None
Thanks all for offering to review. You will find your reviewer's checklist at the top of this issue.
If you encounter any issues please let me know and I can assist.
Hey @xillig
You may want to check out these projects/papers that have previousy worked on twiiter data vizulization and include them under the literature review for your paper.
Also, you need to point our how your package compares to existing work, maybe this list can be a starting point.
hi @sara-02
Thanks a lot for your suggestions. We are doing the review process with JOSS for the first time. Should we just incorporate your comments and then push a new version of the paper? Or how does this usually work? Thank you!
Hi @trallard
Thanks for initiating the review process, I noticed that the issue contains three review check-lists, but @linuxscout is not an assignee of the issue. Will he also review the paper?
hi @sara-02
Thanks a lot for your suggestions. We are doing the review process with JOSS for the first time. Should we just incorporate your comments and then push a new version of the paper? Or how does this usually work? Thank you!
Hye @xillig there is no fixed process, you can keep incorporating the changes as they are suggested or wait for other reviewers to chime in as well. However, if we incorporate the changes on the go, then it will be easier for others when they start reviewing it, they will start from the improved version.
Hi @xillig I also agree with @sara-02 about referring some works regarding twitter data visualization and there's no mention about installation process and describe how this software compares to other commonly-used packages. You may read or look for some JOSS papers which has been published so you can revise the paper directly.
Hi @aozorahime
Thanks for the feedback. We will include the suggestions asap.
Hi @sara-02 and @aozorahime,
we uploaded an updated version of our paper, embedding your suggestions.
@whedon generate pdf
Dear @sara-02, @aozorahime, @linuxscout and @trallard,
we hope that you are all doing well. Can we provide any further assistance regarding the open points? Please also consult the documentation website (https://ttlocvis.readthedocs.io/en/latest/) if you may have questions or write us at any time.
sure @xillig :+1:
Dear @trallard, @sara-02, @aozorahime,
We hope that you are all well and not too severely affected by the current Covid situation. For us a decision about our paper is quiet important in terms of funding applications. Given that the extended review timeline of six weeks is already past since a while, we would kindly like to ask you if you could give us an indication as to when we can expect a conclusion of the review?
Thank you!
xillig
hi @xillig I am sorry I am totally forgot to check the remaining points. but I think its done. maybe we can ask the editor @trallard to process this review
Hey @xillig I am almost done with my review as well, will add the final points in a day or two. Sorry this got delayed.
Dear @sara-02, dear @aozorahime,
Thank you very much for your quick answers! We looking forward to get your review @sara-02.
Thanks and all the best!
@xillig rest of the features and documentation are well put, but where are the commands to run the test listed?
I see you have a test folder but how to operate on it?
As we have to cover that under Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
Issue:
https://github.com/xillig/TTLocVis/issues/1
Also, I feel we can better structure the content of the paper instead of putting everything under the summary heading.
Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?`
So, here is a suggested breakdown:
Summary: Para 1
About the package: para 2(In general...) to para 5 (Above this, the spatial distribution...)
Comparison with existing tools: Para 6 onwards
Hi @sara-02,
you can find the guide for how to run the example files in the documentation under the following link: https://ttlocvis.readthedocs.io/en/latest/examples/
Please note that you can't use the TwitterStreamer without an Twitter Developer account, all other functions are usable with the example data. Please also note that the example data will not return any meaningful analytical results since it is for functional demonstration and tutorial purposes only.
Regarding your suggested breakdown, we will review the paper in regards to your feedback asap.
Thank you and all the best!
Hey, I have reviewed this documentation, my concern is regarding running unit tests.
Is there a way we can test the modules with some dummy twitter data?
Hey, @sara-02,
Thanks for the clarification,
As we have to cover that under
Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
There is no automated unit testing available, since our background is statistics and not computer science, so that we are not firm with unit testing. That's why we decided for the second option to provide manual testing steps as outlined in the "Usage and Example" guideline, to explain how all functions are used.
Hey, I have reviewed this documentation, my concern is regarding running unit tests.
Is there a way we can test the modules with some dummy twitter data?
Using the example data provided (which can be found here: https://github.com/xillig/TTLocVis/tree/master/example_files), you can run all the features of TTLocVis except for the TwitterStreamer class (Which was produced by the TwitterStreamer class). For example you can test the Cleaner class:
from TTLocVis.module import Cleaner
c = Cleaner(load_path=r'path-to-a-JSON-file-folder')
print(c.raw_data)
c.saving(r'path-to-where-the-cleaned-data-shall-be-saved')
where r'path-to-a-JSON-file-folder' should point to the example folder.
I hope this answers your questions
Yes, it does help answer my query. So a person can use the example files to run the manual tests.
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
Hey @sara-02,
we updated the paper.
@xillig and @trallard checks are complete from my side, and my concerns have been dually addressed.
Dear @trallard, @sara-02, @aozorahime,
thank you very much for completing the review and for all the great comments. This really helped a lot to improve the paper and we really appreciate that you invested so much time despite of the COVID-19 situation.
@trallard: What are the next steps in the publication process?
On the JOSS Website we find the following instructions:
>
>
Upon successful completion of the review, authors will make a tagged release of the software, and deposit a copy of the repository with a data-archiving service such as Zenodo or figshare, get a DOI for the archive, and update the review issue thread with the version number and DOI.
Can we proceed with this?
Thank you all very much!
Hi @tallard,
now that @sara-02 and @aozorahime completed their reviews and helped us to really improve TTLocVis a lot, it would really great to make further progress with the review. How can we proceed? What are the next steps? Also @sara-02 and @aozorahime do you perhaps know what to do now?
Thank you all!
xillig
Hey @xillig unfortunetly I am not aware of the next steps.
Hi @trallard,
we already created a tagged release on Zenodo. This is the DOI: https://zenodo.org/badge/latestdoi/258153686
Additionally, we would like to point out once more, that @linuxscout might be assigned as a Reviewer (he/she has a checklist above) but never has been a participant in this issue and probably never reviewed the project. Nevertheless, we do not think this is a problem since there are only two reviews nessesary to move forward, which are by now successfully completed by @sara-02 and @aozorahime.
We hope this helps to move the case forward.
Thank you!
Hi @xillig,
I'm assigned as a Reviewer, but I accepted to review the paper if there are none to do this. When I saw that there are two reviewers, I don't make any action, I follow all the thread, but I think it's not necessary to interact.
If you need my review, I can do it, thanks. See you for other papers.
Hi @linuxscout,
thanks for your message. We agree that no further (third) review is necessary and your valueable work as a reviewer is more important for the numerous other submissions to JOSS!
Thus if @trallard agrees we would proceed with the publication process.
Hey all thanks for your patience and your time doing the reviews. I am going to move forward with the next steps.
@xillig can you please make sure that the software version is up to date and confirm it here?
@whedon set 10.5281/zenodo.4108270 as archive
OK. 10.5281/zenodo.4108270 is the archive.
@whedon generate pdf
@whedon check references
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):
OK DOIs
- None
MISSING DOIs
- 10.1145/2484028.2484166 may be a valid DOI for title: Improving LDA Topic Models for Microblogs via Tweet Pooling and Automatic Labeling
- 10.1016/j.future.2018.01.052 may be a valid DOI for title: From social networks to emergency operation centers: A semantic visualization approach
- 10.1007/978-3-319-31232-3_82 may be a valid DOI for title: TweeProfiles3: visualization of spatio-temporal patterns on Twitter
INVALID DOIs
- None
@xillig there seem to be some DOIs missing, would you be able to check these, please?
Also, I sent a PR with some edits https://github.com/xillig/TTLocVis/pull/3
Finally, from the paper the following authors are listed:
- name: Gillian Kant
orcid: 0000-0003-2346-2841
affiliation: 1
- name: Christoph Weisser
orcid: 0000-0003-0616-1027
affiliation: "1, 2"
- name: Benjamin Säfken
orcid: 0000-0003-4702-3333
affiliation: "1, 2"
But the archive in Zenodo only lists the first two authors
@whedon set 10.5281/zenodo.4108270 as archive
I'm sorry @xillig, I'm afraid I can't do that. That's something only editors are allowed to do.
Dear @trallard,
Thank you for all your efforts. We included the DOIs of the references and fixed authorship issue in zenodo by making a new release. We also merged your changes into master. We can also confirm that the software version is up to date: The version number is 1.0.4, with the same DOI as before: https://zenodo.org/badge/latestdoi/258153686
Thanks to everyone for their contributions.
All the best,
Gillian, Christoph and Benjamin
@whedon check references
@whedon generate pdf
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):
OK DOIs
- 10.1145/2484028.2484166 is OK
- 10.1016/j.future.2018.01.052 is OK
MISSING DOIs
- None
INVALID DOIs
- None
@whedon set 10.5281/zenodo.4115669 as archive
OK. 10.5281/zenodo.4115669 is the archive.
@whedon set 1.0.4 as version
OK. 1.0.4 is the version.
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
@xillig everything seems in order now. I will go ahead and pass to our EiC for the final steps through publication.
@sara-02 , @aozorahime thanks for your time and effort as part of the review. Your contributions are massively appreciated. ✨
@whedon accept
Attempting dry run of processing paper acceptance...
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):
OK DOIs
- 10.1145/2484028.2484166 is OK
- 10.1016/j.future.2018.01.052 is OK
MISSING DOIs
- None
INVALID DOIs
- None
:wave: @openjournals/joss-eics, this paper is ready to be accepted and published.
Check final proof :point_right: https://github.com/openjournals/joss-papers/pull/1839
If the paper PDF and Crossref deposit XML look good in https://github.com/openjournals/joss-papers/pull/1839, then you can now move forward with accepting the submission by compiling again with the flag deposit=true
e.g.
@whedon accept deposit=true
I am so happy to be part of this. Thank you everyone. And good luck for @xillig for the next publication journey 😁
@whedon accept deposit=true
I'm sorry @xillig, I'm afraid I can't do that. That's something only editor-in-chiefs are allowed to do.
Thank you everyone for their work!
@trallard, would you kindly accept the submission?
Hi @xillig I am afraid only our editors in chief can do this. They should have received a notification and will deal with this promptly
Hi @xillig, I'm the EIC on duty this week, doing some final checks before publishing. Can
Hi @kyleniemeyer,
thank you very much for your feedback. Unfortunatly, for the two references that have no DOIs now, there are none available to your knowledge. Appart from that, we have incorporated all of your suggested points. Please let us know if we can do anything else or move forward.
Thanks to everyone!
@whedon generate pdf
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
@whedon set 10.5281/zenodo.4133399 as archive
OK. 10.5281/zenodo.4133399 is the archive.
@whedon accept
Attempting dry run of processing paper acceptance...
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):
OK DOIs
- 10.1145/2484028.2484166 is OK
- 10.1162/jmlr.2003.3.4-5.993 is OK
- 10.1145/2492517.2492639 is OK
- 10.1016/j.future.2018.01.052 is OK
MISSING DOIs
- None
INVALID DOIs
- None
:wave: @openjournals/joss-eics, this paper is ready to be accepted and published.
Check final proof :point_right: https://github.com/openjournals/joss-papers/pull/1866
If the paper PDF and Crossref deposit XML look good in https://github.com/openjournals/joss-papers/pull/1866, then you can now move forward with accepting the submission by compiling again with the flag deposit=true
e.g.
@whedon accept deposit=true
@whedon accept deposit=true
Doing it live! Attempting automated processing of paper acceptance...
🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦
🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨
Here's what you must now do:
Party like you just published a paper! 🎉🌈🦄💃👻🤘
Any issues? Notify your editorial technical team...
Congrats @xillig on your article's publication in JOSS!
Many thanks to @sara-02 , @linuxscout, and @aozorahime for reviewing this submission, and @trallard for editing it.
:tada::tada::tada: Congratulations on your paper acceptance! :tada::tada::tada:
If you would like to include a link to your paper from your README use the following code snippets:
Markdown:
[](https://doi.org/10.21105/joss.02507)
HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.02507">
<img src="https://joss.theoj.org/papers/10.21105/joss.02507/status.svg" alt="DOI badge" >
</a>
reStructuredText:
.. image:: https://joss.theoj.org/papers/10.21105/joss.02507/status.svg
:target: https://doi.org/10.21105/joss.02507
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:
Thank you everyone for your awesome work!
Best wishes,
Gillian, Christoph, Benjamin
Most helpful comment
Congrats @xillig on your article's publication in JOSS!
Many thanks to @sara-02 , @linuxscout, and @aozorahime for reviewing this submission, and @trallard for editing it.