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]: osmapiR: An 'OpenStreetMap API' implementation for R #7151

Closed
editorialbot opened this issue Aug 28, 2024 · 24 comments
Closed

[REVIEW]: osmapiR: An 'OpenStreetMap API' implementation for R #7151

editorialbot opened this issue Aug 28, 2024 · 24 comments
Assignees
Labels
accepted published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review rOpenSci Submissions associated with rOpenSci Track: 8 (MISC) Miscellaneous

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Aug 28, 2024

Submitting author: @jmaspons (Joan Maspons)
Repository: https://github.com/ropensci/osmapiR
Branch with paper.md (empty if default branch): joss
Version: v0.2.0
Editor: @arfon
Reviewers: @jonthegeek, @ccamara
Archive: 10.5281/zenodo.13627998

Status

status

Status badge code:

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

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

@jonthegeek & @ccamara, 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 @arfon 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

@jonthegeek, please create your checklist typing: @editorialbot generate my checklist

@ccamara, please create your checklist typing: @editorialbot generate my checklist

@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

@arfon arfon added the rOpenSci Submissions associated with rOpenSci label Aug 28, 2024
@editorialbot
Copy link
Collaborator Author

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

✅ OK DOIs

- 10.32614/CRAN.package.osmapiR is OK
- 10.21105/joss.00305 is OK
- 10.32614/CRAN.package.osmextract is OK
- 10.32614/CRAN.package.OpenStreetMap is OK
- 10.32614/RJ-2018-009 is OK
- 10.32614/CRAN.package.xml2 is OK
- 10.32614/RJ-2019-041 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: R: A Language and Environment for Statistical Comp...

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.90  T=0.53 s (404.6 files/s, 486158.1 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
R                               71           1523           4558         131563
XML                             89             32              0          88849
JSON                            31              3              0          25059
Markdown                        10            260              0           3214
SVG                              1             26              1           1104
YAML                             7             34             24            359
TeX                              1              7              0             75
Rmd                              4            110            302             45
-------------------------------------------------------------------------------
SUM:                           214           1995           4885         250268
-------------------------------------------------------------------------------

Commit count by author:

   309	Joan Maspons
     3	Carlos Cámara
     2	Maëlle Salmon
     1	Neal Richardson

@editorialbot
Copy link
Collaborator Author

Paper file info:

📄 Wordcount for paper.md is 306

✅ The paper includes a Statement of need section

@editorialbot
Copy link
Collaborator Author

License info:

🟡 License found: GNU General Public License v3.0 (Check here for OSI approval)

@arfon
Copy link
Member

arfon commented Aug 28, 2024

Again, please ignore the instructions here @jonthegeek & @ccamara – there's no additional review work to do here, rather, we're crediting you for your efforts on the earlier rOpenSci review: ropensci/software-review#633

@arfon
Copy link
Member

arfon commented Aug 28, 2024

@jmaspons – looks like we're very close to being done here. I will circle back here next week, but in the meantime, please give your own paper a final read to check for any potential typos etc.

Please make an archive of the software in Zenodo/figshare/other service and update this thread with the DOI of the archive? For the Zenodo/figshare archive, please make sure that:

  • The title of the archive is the same as the JOSS paper title
  • I can then move forward with accepting the submission.

@editorialbot
Copy link
Collaborator Author

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

@jmaspons
Copy link

jmaspons commented Sep 2, 2024

@editorialbot set 10.5281/zenodo.13627998 as archive

@editorialbot
Copy link
Collaborator Author

I'm sorry @jmaspons, I'm afraid I can't do that. That's something only editors are allowed to do.

@jmaspons
Copy link

jmaspons commented Sep 2, 2024

Archive at 10.5281/zenodo.13627998, @arfon

@arfon
Copy link
Member

arfon commented Sep 4, 2024

@editorialbot set 10.5281/zenodo.13627998 as archive

@editorialbot
Copy link
Collaborator Author

Done! archive is now 10.5281/zenodo.13627998

@arfon
Copy link
Member

arfon commented Sep 4, 2024

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator Author

Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator Author

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

✅ OK DOIs

- 10.32614/CRAN.package.osmapiR is OK
- 10.21105/joss.00305 is OK
- 10.32614/CRAN.package.osmextract is OK
- 10.32614/CRAN.package.OpenStreetMap is OK
- 10.32614/RJ-2018-009 is OK
- 10.32614/CRAN.package.xml2 is OK
- 10.32614/RJ-2019-041 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: R: A Language and Environment for Statistical Comp...

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👋 @openjournals/misc-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#5846, 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 4, 2024
@arfon
Copy link
Member

arfon commented Sep 4, 2024

@editorialbot accept

@editorialbot
Copy link
Collaborator Author

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

@editorialbot
Copy link
Collaborator Author

Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository.

If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file.

You can copy the contents for your CITATION.cff file here:

CITATION.cff

cff-version: "1.2.0"
authors:
- family-names: Maspons
  given-names: Joan
  orcid: "https://orcid.org/0000-0003-2286-8727"
doi: 10.5281/zenodo.13627998
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Maspons
    given-names: Joan
    orcid: "https://orcid.org/0000-0003-2286-8727"
  date-published: 2024-09-04
  doi: 10.21105/joss.07151
  issn: 2475-9066
  issue: 101
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 7151
  title: "osmapiR: An 'OpenStreetMap API' implementation for R"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.07151"
  volume: 9
title: "osmapiR: An 'OpenStreetMap API' implementation for R"

If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation.

Find more information on .cff files here and here.

@editorialbot
Copy link
Collaborator Author

🐘🐘🐘 👉 Toot 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.07151 joss-papers#5848
  2. Wait five minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.07151
  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 the published Papers published in JOSS label Sep 4, 2024
@arfon
Copy link
Member

arfon commented Sep 4, 2024

@jonthegeek, @ccamara – many thanks for your (rOpenSci) reviews. JOSS relies upon the volunteer effort of people like you and we simply wouldn't be able to do this without you ✨

@jmaspons – your paper is now accepted and published in JOSS ⚡🚀💥

@arfon arfon closed this as completed Sep 4, 2024
@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.07151/status.svg)](https://doi.org/10.21105/joss.07151)

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

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

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:

jmaspons added a commit to ropensci/osmapiR that referenced this issue Sep 4, 2024
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 recommend-accept Papers recommended for acceptance in JOSS. review rOpenSci Submissions associated with rOpenSci Track: 8 (MISC) Miscellaneous
Projects
None yet
Development

No branches or pull requests

3 participants