[REVIEW]: TTLocVis: A Twitter Topic Location Visualization Package

[whedon]

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

⚠️ JOSS reduced service mode ⚠️

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

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/448cbcd790258531fd790d0225442c94"><img src="https://joss.theoj.org/papers/448cbcd790258531fd790d0225442c94/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/448cbcd790258531fd790d0225442c94/status.svg)](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.)

Reviewer instructions & questions

@sara-02 & @linuxscout & @aozorahime, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:

1. Make sure you're logged in to your GitHub account
2. Be sure to accept the invite at this URL: https://github.com/openjournals/joss-reviews/invitations

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 ✨

Review checklist for @sara-02

Conflict of interest

• I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

• I confirm that I read and will adhere to the JOSS code of conduct.

General checks

• Repository: Is the source code for this software available at the repository url?
• License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
• Contribution and authorship: Has the submitting author (@xillig) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
• Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

• Installation: Does installation proceed as outlined in the documentation?
• Functionality: Have the functional claims of the software been confirmed?
• Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

• A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
• Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
• Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
• Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
• Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

• Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
• A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• State of the field: Do the authors describe how this software compares to other commonly-used packages?
• Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
• References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

Review checklist for @linuxscout

Conflict of interest

• I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

• I confirm that I read and will adhere to the JOSS code of conduct.

General checks

• Repository: Is the source code for this software available at the repository url?
• License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
• Contribution and authorship: Has the submitting author (@xillig) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
• Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

• Installation: Does installation proceed as outlined in the documentation?
• Functionality: Have the functional claims of the software been confirmed?
• Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

• A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
• Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
• Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
• Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
• Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

• Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
• A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• State of the field: Do the authors describe how this software compares to other commonly-used packages?
• Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
• References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

Review checklist for @aozorahime

Conflict of interest

• I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

• I confirm that I read and will adhere to the JOSS code of conduct.

General checks

• Repository: Is the source code for this software available at the repository url?
• License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
• Contribution and authorship: Has the submitting author (@xillig) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
• Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

• Installation: Does installation proceed as outlined in the documentation?
• Functionality: Have the functional claims of the software been confirmed?
• Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

• A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
• Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
• Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
• Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
• Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

• Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
• A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• State of the field: Do the authors describe how this software compares to other commonly-used packages?
• Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
• References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

[whedon]

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 🎉.

⚠️ JOSS reduced service mode ⚠️

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.

⭐ 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:

1. Set yourself as 'Not watching' https://github.com/openjournals/joss-reviews:

2. You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/notifications

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

[whedon]

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

[whedon]

👉 Check article proof 📄 👈

[trallard]

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.

[sara-02]

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.

• https://www.csc2.ncsu.edu/faculty/healey/tweet_viz/
• Q. Kong, R. Ram, and M.-A. Rizoiu, “A toolkit for analyzing andvisualizing online users via reshare cascade modeling,”ArXiv, vol.abs/2006.06167, 2020.
• S. Malik, A. Smith, T. Hawes, P. Papadatos, J. Li, C. Dunne, andB. Shneiderman, “Topicflow: Visualizing topic alignment of twitter dataover time,” inASONAM, 2013, p. 720–726.
• Florence Ying Wang, A. Sallaberry, K. Klein, M. Takatsuka, andM. Roche, “Senticompass: Interactive visualization for exploring andcomparing the sentiments of time-varying twitter data,” inPacificVis,2015, pp. 129–133.
• M. Hu, K. Wongsuphasawat, and J. Stasko, “Visualizing social mediacontent with sententree,”IEEE Transactions on Visualization and Com-puter Graphics, vol. 23, no. 1, pp. 621–630, 2017

[xillig]

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!

[xillig]

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?

[sara-02]

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.

[aozorahime]

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.

[xillig]

Hi @aozorahime
Thanks for the feedback. We will include the suggestions asap.

[xillig]

Hi @sara-02 and @aozorahime,
we uploaded an updated version of our paper, embedding your suggestions.

[sara-02]

@whedon generate pdf

[whedon]

👉 Check article proof 📄 👈

[xillig]

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.

[aozorahime]

sure @xillig 👍

[xillig]

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

[aozorahime]

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

[sara-02]

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.

[xillig]

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!

[sara-02]

@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?

[sara-02]

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:
xillig/TTLocVis#1

[sara-02]

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)?`

[sara-02]

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 

[whedon]

Attempting dry run of processing paper acceptance...

[whedon]

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]

👋 @openjournals/joss-eics, this paper is ready to be accepted and published.

Check final proof 👉 openjournals/joss-papers#1839

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#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

[aozorahime]

I am so happy to be part of this. Thank you everyone. And good luck for @xillig for the next publication journey 😁

[xillig]

@whedon accept deposit=true

[whedon]

I'm sorry @xillig, I'm afraid I can't do that. That's something only editor-in-chiefs are allowed to do.

[xillig]

Thank you everyone for their work!

@trallard, would you kindly accept the submission?

[trallard]

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

[kyleniemeyer]

Hi @xillig, I'm the EIC on duty this week, doing some final checks before publishing. Can

• Please edit the Zenodo archive author list to match the paper—it looks like @trallard got included!
• Your article is missing an explicit Statement of Need section, which we have begun requiring for articles. Can you please add? You may be able to use existing text in the paper.
• In the last paragraph of the "Comparison with existing tools" section, I think there is an extraneous comma before the citation.
• The Kong 2020 reference seems to be missing some details
• Are there DOIs available for the other references?

[xillig]

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!

[kyleniemeyer]

@whedon generate pdf

[whedon]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[kyleniemeyer]

@whedon set 10.5281/zenodo.4133399 as archive

[whedon]

OK. 10.5281/zenodo.4133399 is the archive.

[kyleniemeyer]

@whedon accept

[whedon]

Attempting dry run of processing paper acceptance...

[whedon]

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

[whedon]

👋 @openjournals/joss-eics, this paper is ready to be accepted and published.

Check final proof 👉 openjournals/joss-papers#1866

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#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

[kyleniemeyer]

@whedon accept deposit=true

[whedon]

Doing it live! Attempting automated processing of paper acceptance...

[whedon]

🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦

[whedon]

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

0. Check final PDF and Crossref metadata that was deposited 👉 Creating pull request for 10.21105.joss.02507 joss-papers#1867
1. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.02507
2. If everything looks good, then close this review issue.
3. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

[kyleniemeyer]

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.

[whedon]

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](https://joss.theoj.org/papers/10.21105/joss.02507/status.svg)](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:

• Volunteering to review for us sometime in the future. You can add your name to the reviewer list here: https://joss.theoj.org/reviewer-signup.html
• Making a small donation to support our running costs here: https://numfocus.org/donate-to-joss

[xillig]

Thank you everyone for your awesome work!

Best wishes,
Gillian, Christoph, Benjamin