Skip to content
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]: glottospace: R package for language mapping and geospatial analysis of linguistic and cultural data #4303

Closed
editorialbot opened this issue Apr 7, 2022 · 74 comments
Assignees
Labels
accepted published Papers published in JOSS R recommend-accept Papers recommended for acceptance in JOSS. review TeX

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Apr 7, 2022

Submitting author: @SietzeN (Sietze Norder)
Repository: https://github.com/SietzeN/glottospace
Branch with paper.md (empty if default branch): main
Version: v0.0.113
Editor: @ajstewartlang
Reviewers: @fauxneticien, @skalyan91
Archive: 10.5281/zenodo.7064529

Status

status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/c93a1ccb6835a15c6026ea1ddc28b50c"><img src="https://joss.theoj.org/papers/c93a1ccb6835a15c6026ea1ddc28b50c/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/c93a1ccb6835a15c6026ea1ddc28b50c/status.svg)](https://joss.theoj.org/papers/c93a1ccb6835a15c6026ea1ddc28b50c)

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

@fauxneticien & @skalyan91, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review.
First of all you need to run this command in a separate comment to create the checklist:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @ajstewartlang 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

Checklists

📝 Checklist for @skalyan91

📝 Checklist for @fauxneticien

@editorialbot
Copy link
Collaborator Author

Hello humans, I'm @editorialbot, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.88  T=0.08 s (449.6 files/s, 89602.3 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
R                               27            582           2040           2412
Markdown                         4            324              0           1095
TeX                              1             14              0            123
YAML                             2             11              6             51
Rmd                              1             90            188             40
-------------------------------------------------------------------------------
SUM:                            35           1021           2234           3721
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@editorialbot
Copy link
Collaborator Author

Wordcount for paper.md is 1101

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1371/journal.pone.0158391 is OK
- 10.32614/RJ-2018-009 is OK
- 10.1038/sdata.2018.205 is OK
- 10.1007/978-3-540-74686-7 is OK
- 10.3233/sw-212843 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

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

@skalyan91
Copy link

skalyan91 commented Apr 7, 2022

Review checklist for @skalyan91

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

General checks

  • Repository: Is the source code for this software available at the https://github.com/SietzeN/glottospace?
  • 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 (@SietzeN) 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: Does the paper have a section titled 'Statement of Need' that clearly states 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?

@skalyan91
Copy link

@editorialbot commands

@editorialbot
Copy link
Collaborator Author

Hello @skalyan91, here are the things you can ask me to do:


# List all available commands
@editorialbot commands

# Get a list of all editors's GitHub handles
@editorialbot list editors

# Check the references of the paper for missing DOIs
@editorialbot check references

# Perform checks on the repository
@editorialbot check repository

# Adds a checklist for the reviewer using this command
@editorialbot generate my checklist

# Set a value for branch
@editorialbot set joss-paper as branch

# Generates the pdf paper
@editorialbot generate pdf

# Get a link to the complete list of reviewers
@editorialbot list reviewers

@fauxneticien
Copy link

fauxneticien commented May 1, 2022

Review checklist for @fauxneticien

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

General checks

  • Repository: Is the source code for this software available at the https://github.com/SietzeN/glottospace?
  • 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 (@SietzeN) 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: Does the paper have a section titled 'Statement of Need' that clearly states 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?

@ajstewartlang
Copy link

👋 @skalyan91 and @fauxneticien I'm just checking in to see that your reviews are progressing ok. If you could let me know, that would be great.

@skalyan91
Copy link

@ajstewartlang Yes, it’s going OK so far. I’ll try to finish it this weekend.

@fauxneticien
Copy link

@ajstewartlang — same, I'll finish it up this weekend

@fauxneticien
Copy link

@ajstewartlang — I see that there are in-text citations (e.g. [@Wickham:2016] on page 3) in the draft paper (https://github.com/openjournals/joss-papers/blob/joss.04303/joss.04303/10.21105.joss.04303.pdf) but the references section is empty. Is that an artefact of the build?

@ajstewartlang
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@ajstewartlang
Copy link

@editorialbot set joss as branch

@editorialbot
Copy link
Collaborator Author

Done! branch is now joss

@ajstewartlang
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@ajstewartlang
Copy link

👋 @SietzeN can you check the citations in the file paper.md please? The reference list isn't appearing in the pdf build as I believe it's because the citations are not in the appropriate format in paper.md. The backticks aren't need in the markdown file - you can see an example paper with bibliography here.

@skalyan91
Copy link

skalyan91 commented Jun 17, 2022

@SietzeN
Copy link

SietzeN commented Jun 17, 2022

Thanks a lot @skalyan91, @fauxneticien and @ajstewartlang for all your time and effort! I'll soon make a start with addressing your comments. Regarding the reference list, I'll remove the backticks from the markdown file. Cheers!

@skalyan91
Copy link

@ajstewartlang I’ve opened the following issues on the project’s GitHub repository:

  1. JOSS review: Software paper glottospace/glottospace#98
  2. JOSS review: Error handling glottospace/glottospace#99
  3. JOSS review: Issues with examples in readme glottospace/glottospace#100
  4. JOSS review: Saving as .gpkg glottospace/glottospace#101
  5. JOSS review: Instructions for contributors glottospace/glottospace#102
  6. JOSS review: glottoclean behaviour glottospace/glottospace#103
  7. JOSS review: glottoconvert behaviour and documentation glottospace/glottospace#104
  8. JOSS review: unimplemented arguments in glottocreate glottospace/glottospace#105
  9. JOSS review: use of “regular expression” in glottofilter documentation glottospace/glottospace#106
  10. JOSS review: Instructions for glottomap and glottofiltermap glottospace/glottospace#107
  11. JOSS review: Update D-PLACE support status in glottoget documentation glottospace/glottospace#108
  12. JOSS review: glottovars() is unimplemented glottospace/glottospace#109
  13. JOSS review: Projection specification in glottomap glottospace/glottospace#110
  14. JOSS review: Use na.rm instead of rm.na glottospace/glottospace#111
  15. JOSS review: Issues with glottonmds glottospace/glottospace#112
  16. JOSS review: Additional description/references for glottostat_permanova glottospace/glottospace#113

Once these issues have been dealt with, I can check off the remaining items on my checklist, at which point my review will be complete.

@ajstewartlang
Copy link

Many thanks for your great submission @SietzeN and huge thanks to @skalyan91 and @fauxneticien for your time and really helpful reviews!

@ajstewartlang
Copy link

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator Author

Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator Author

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

Check final proof 👉📄 Download article

If the paper PDF and the deposit XML files look good in openjournals/joss-papers#3507, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@editorialbot editorialbot added the recommend-accept Papers recommended for acceptance in JOSS. label Sep 9, 2022
@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1371/journal.pone.0158391 is OK
- 10.32614/RJ-2018-009 is OK
- 10.1038/sdata.2018.205 is OK
- 10.1007/978-3-540-74686-7 is OK
- 10.3233/sw-212843 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@SietzeN
Copy link

SietzeN commented Sep 9, 2022

Thanks @ajstewartlang! Looks great!

@danielskatz
Copy link

Hi @SietzeN - I'm the AEiC who will do the final processing of your submission. I'm suggesting a few small changes in glottospace/glottospace#123. Please merge this, or let me know what you disagree with, and we can move to acceptance and publication.

@SietzeN
Copy link

SietzeN commented Sep 12, 2022

Hi @danielskatz !
Thanks a lot for your message. I've just merged the pull request.
All the best,
Sietze

@danielskatz
Copy link

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator Author

Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator Author

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

Check final proof 👉📄 Download article

If the paper PDF and the deposit XML files look good in openjournals/joss-papers#3508, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@danielskatz
Copy link

@editorialbot accept

@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

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

Here's what you must now do:

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

Any issues? Notify your editorial technical team...

@editorialbot editorialbot added accepted published Papers published in JOSS labels Sep 12, 2022
@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1371/journal.pone.0158391 is OK
- 10.32614/RJ-2018-009 is OK
- 10.1038/sdata.2018.205 is OK
- 10.1007/978-3-540-74686-7 is OK
- 10.3233/sw-212843 is OK

MISSING DOIs

- Errored finding suggestions for "tmap: Thematic Maps in R", please try later
- Errored finding suggestions for "Dryer, Matthew S. & Haspelmath, Martin (eds.) The ...", please try later
- Errored finding suggestions for "Glottolog 4.5. Leipzig: Max Planck Institute for E...", please try later
- Errored finding suggestions for "dplyr: A grammar of data manipulation. R package v...", please try later
- Errored finding suggestions for "rnaturalearth: World Map Data from Natural Earth. ...", please try later
- Errored finding suggestions for "glottoTrees: Phylogenetic trees in Linguistics", please try later
- Errored finding suggestions for "lingtypology: easy mapping for Linguistic Typology", please try later
- Errored finding suggestions for "lingtypR: easy data manipulation for typologists", please try later
- Errored finding suggestions for "qlcData: Processing Data for Quantitative Language...", please try later
- Errored finding suggestions for "PHOIBLE 2.0. Jena: Max Planck Institute for the Sc...", please try later

INVALID DOIs

- None

@danielskatz
Copy link

Congratulations to @SietzeN (Sietze Norder) and co-authors!!

And thanks to @fauxneticien and @skalyan91 for reviewing, and to @ajstewartlang for editing!
We couldn't do this without you

@editorialbot
Copy link
Collaborator Author

🎉🎉🎉 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.04303/status.svg)](https://doi.org/10.21105/joss.04303)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.04303">
  <img src="https://joss.theoj.org/papers/10.21105/joss.04303/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://joss.theoj.org/papers/10.21105/joss.04303/status.svg
   :target: https://doi.org/10.21105/joss.04303

This is how it will look in your documentation:

DOI

We need your help!

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

@SietzeN
Copy link

SietzeN commented Sep 12, 2022

Thanks again @danielskatz @ajstewartlang @skalyan91 @fauxneticien !!

@ajstewartlang
Copy link

👋 @SietzeN I am handling a new JOSS submission that seems to overlap nicely with your expertise. Might you have the bandwidth to review it please? It would be very much appreciated. The submission can be found here: https://github.com/marccanby/linguiphyr/

@SietzeN
Copy link

SietzeN commented Feb 16, 2024 via email

@ajstewartlang
Copy link

Many thanks @SietzeN - if you could, that would be a great help. I'll go ahead and add you as a reviewer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted published Papers published in JOSS R recommend-accept Papers recommended for acceptance in JOSS. review TeX
Projects
None yet
Development

No branches or pull requests

6 participants