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.

Sign up for GitHub

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

Jump to bottom

[REVIEW]: gaussplotR: Fit, Predict and Plot 2D Gaussians in R #3074

Closed
40 tasks done
whedon opened this issue Mar 1, 2021 · 58 comments
Closed
40 tasks done

[REVIEW]: gaussplotR: Fit, Predict and Plot 2D Gaussians in R #3074

whedon opened this issue Mar 1, 2021 · 58 comments
Assignees
@cddesja @KristinaRiemer @brunaw
Labels
accepted HTML published Papers published in JOSS R recommend-accept Papers recommended for acceptance in JOSS. review TeX

Comments

@whedon
Copy link

whedon commented Mar 1, 2021 •
edited

Submitting author: @vbaliga (Vikram B. Baliga)
Repository: https://github.com/vbaliga/gaussplotR
Version: v0.2.5
Editor: @KristinaRiemer
Reviewer: @cddesja, @brunaw
Archive: 10.5281/zenodo.4657750

⚠️ 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

Status badge code:

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

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

@cddesja & @brunaw, 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 @KristinaRiemer 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 @cddesja

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 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 (@vbaliga) 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: 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?
  • 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 @brunaw

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 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 (@vbaliga) 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: 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?
  • 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 whedon mentioned this issue Mar 1, 2021
Closed
@whedon
Copy link
Author

whedon commented Mar 1, 2021

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @cddesja, @brunaw 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:

watching

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

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
Copy link
Author

whedon commented Mar 1, 2021 

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

OK DOIs

- 10.1152/jn.1994.71.6.2517 is OK
- 10.1523/JNEUROSCI.23-13-05650.2003 is OK
- 10.1152/jn.00921.2005 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Mar 1, 2021 

Software report (experimental):

github.com/AlDanial/cloc v 1.88  T=0.17 s (392.9 files/s, 74226.1 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
HTML                            21           1068            260           4534
R                               19            363            768           2192
Markdown                         7            191              0            791
CSS                              3             99             48            428
JavaScript                       3             64             32            256
JSON                             1              0              0            180
Rmd                              4            166            417            159
YAML                             4             27              2            137
TeX                              1              2              0             43
XML                              1              0              0             42
SVG                              1              0              1             11
-------------------------------------------------------------------------------
SUM:                            65           1980           1528           8773
-------------------------------------------------------------------------------


Statistical information for the repository '7a910df144f30d294c8e2399' was
gathered on 2021/03/01.
The following historical commit information, by author, was found:

Author                     Commits    Insertions      Deletions    % of changes
Vikram Baliga                    1           352              0          100.00

Below are the number of rows from each author that have survived and are still
intact in the current revision:

Author                     Rows      Stability          Age       % in comments
Vikram Baliga               352          100.0          0.0                9.09

@whedon
Copy link
Author

whedon commented Mar 1, 2021

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

@brunaw
Copy link

brunaw commented Mar 1, 2021

I'm done with my review, a few comments justifying what I missed in the package & suggestions are below:

  • I couldn't straightforwardly install the package from either CRAN or GitHub because of the R version requirement (>= 4.0.0). I find this a high requirement given that this version (4.0.0) is not even 1 year old yet. I managed to install the package only by manually changing this requirement and no harm was done with that, so unless the authors really need this requirement I would suggest downgrading it.

  • Just for aesthetics purposes, I suggest rounding the numbers when showing them in the summaries of the models. Using 5 decimals for each value shown used quite a lot of space on my screen.

  • I found no explicit contribution guide, either in the webpage or GitHub repository of the package. This could be added at the end of the README in the GitHub repository.

  • About the paper:

    • Assuming the summary to be the main thing that people read, it certainly needs more details. There's just a short statement of what the package does with no 'clear description of the high-level functionality and purpose of the software for a diverse audience'. I suggest giving at least a quick explanation on 2D Gaussians, why we use them, what are a few examples of it, and why/how the package helps you fitting/plotting them.
    • The same goes for the statement of need, there's seem to be very little justification of why we need this package (I believe we do need it, but the justification for that is lacking), and what is already written seem to be quite generic.
    • References need to be fixed in the statement of need.
    • More references can be added, which will both help to improve the statement of need (by showing how 2D Gaussians have been used in the literature) and to improve the main summary itself.
    • Even though the authors state that there's no other package in the literature that automatically handles the fitting of 2D Gaussians, this package itself is based on functions from previous packages (from the nls package for instance, and classical 2D plotting functions). I suggest something is written about that and what are the advantages of using this package (besides being quicker & easier) than other such approaches.

Please let me know if any of this isn't clear or if I can improve my suggestions,

Bruna

@KristinaRiemer
Copy link

Thanks for the quick turnaround time on the review @brunaw! Your comments are useful, and I definitely agree with adding contribution information and fleshing out the use cases of the package in the paper. Hopefully @vbaliga will have a chance to address them soon!

@cddesja
Copy link

cddesja commented Mar 5, 2021 via email

@vbaliga
Copy link

vbaliga commented Mar 12, 2021

Hi everyone - Thanks sincerely to @brunaw for your review. I am happy to incorporate your feedback. If it's OK, I'd like to hold off until @cddesja has a chance to submit his review too, so that he does not have to review a moving target.

Best regards,
Vikram
🐢

@cddesja
Copy link

cddesja commented Mar 13, 2021 via email

@cddesja
Copy link

cddesja commented Mar 15, 2021 via email

@whedon
Copy link
Author

whedon commented Mar 15, 2021

👋 @brunaw, please update us on how your review is going (this is an automated reminder).

@whedon
Copy link
Author

whedon commented Mar 15, 2021

👋 @cddesja, please update us on how your review is going (this is an automated reminder).

@cddesja
Copy link

cddesja commented Mar 15, 2021 via email

@danielskatz
Copy link

@whedon re-invite @cddesja as reviewer

@whedon
Copy link
Author

whedon commented Mar 15, 2021

OK, the reviewer has been re-invited.

@cddesja please accept the invite by clicking this link: https://github.com/openjournals/joss-reviews/invitations

@openjournals openjournals deleted a comment from whedon Mar 15, 2021
@KristinaRiemer
Copy link

Thanks for doing that @danielskatz! Let us know if that doesn't work @cddesja.

@cddesja
Copy link

cddesja commented Mar 16, 2021

I am done with my review as well.

  • A couple of references need to be fixed, line 14 and line 30.
  • The last sentence of the paper you may want to change the word "the" to "an"
  • As @brunaw stated there's no contribution guide.
  • I do suspect there are some 2d Gaussian packages in R that could be cited as relevant, if not providing, similar functionality. A quick search finds package with similar names.
  • I think it would be beneficial to list all the package requirements on your GitHub site.
  • I really appreciate the way that the package allows for easy use with ggplot2 and lattice.
  • I am not sure that I agree with @brunaw about whether you need to change the R requirements to allow for R less than 4. While I totally agree with her rationale, I don't think it's necessarily your responsibility to make sure that the package is backwards compatible. However, if @brunaw feels strongly about this, then I think the request is more than reasonable.
  • Regarding @brunaw request about the statement of need and the summary section, would it be possible to walk the reader through an applied application of your package? For example, you reference an in-press paper, could you walk us through the problem you encountered and how your package helped to solve it in non-technical language?

Chris

@brunaw
Copy link

brunaw commented Mar 16, 2021 •
edited

Hello @cddesja and @vbaliga,

After I posted my review, I was thinking about my comment about the R version. Indeed it's not "too much" to ask for R to be at least 4.0.0, because it's been a while that this version is available so maybe it's my obligation as the package user to update my R already.

So in summary, I think this is up to the authors to decide on. I would personally not request a certain R version if my package really didn't depend on it (to avoid issues like I had), but I also don't see any major issues with keeping the version request as it is 😊

@cddesja
Copy link

cddesja commented Mar 16, 2021

"I would personally not request a certain R version if my package really didn't depend on it (to avoided issues like I had)"

This is a good reason to not require 4.0. So, I think @brunaw you're right that this requirement should be removed.

@vbaliga
Copy link

vbaliga commented Mar 19, 2021

Hi @brunaw and @cddesja,

Thanks sincerely to both of you for reviewing gaussplotR and providing feedback. I think you've both found ways to improve the package and the corresponding paper, and I am grateful for it. Here are my point-by-point replies:

@brunaw

* I couldn't straightforwardly install the package from either CRAN or GitHub because of the R version requirement (>= 4.0.0). I find this a high requirement given that this version (4.0.0) is not even 1 year old yet. I managed to install the package only by manually changing this requirement and no harm was done with that, so unless the authors really need this requirement I would suggest downgrading it.

I agree. Forcing users to have R >= 4.0.0 was too stringent a requirement and not necessary for the package's current functionality. I scanned through all of gaussplotR's dependencies and found that R >= 3.3.0 is a suitable requirement as rgl depends on it. Thanks for catching this!

* Just for aesthetics purposes, I suggest rounding the numbers when showing them in the summaries of the models.  Using 5 decimals for each value shown used quite a lot of space on my screen.

This was a great suggestion and one that motivated me to write custom print() and summary() methods for my fit_gaussian_2D() outputs. I have now simplified the printed output to be more clean and opted to round each parameter estimate to 2 decimal places.

* I found no explicit contribution guide, either in the webpage or GitHub repository of the package. This could be added at the end of the README in the GitHub repository.

Thanks. The reason this wasn't there before was because it doesn't seem to be a requirement for JOSS. But in any case, I agree with the merit of adding it and have placed a section within the README that provides this info. Thanks for the suggestion.

* About the paper:
  
  * Assuming the summary to be the main thing that people read, it certainly needs more details. There's just a short statement of what the package does with no 'clear description of the high-level functionality and purpose of the software for a diverse audience'. I suggest giving at least a quick explanation on 2D Gaussians, why we use them, what are a few examples of it, and why/how the package helps you fitting/plotting them.
  * The same goes for the statement of need, there's seem to be very little justification of why we need this package (I believe we do need it, but the justification for that is lacking), and what is already written seem to be quite generic.
  * References need to be fixed in the statement of need.
  * More references can be added, which will both help to improve the statement of need (by showing how 2D Gaussians have been used in the literature) and to improve the main summary itself.
  * Even though the authors state that there's no other package in the literature that automatically handles the fitting of 2D Gaussians, this package itself is based on functions from previous packages (from the `nls` package for instance, and classical 2D plotting functions). I suggest something is written about that and what are the advantages of using this package (besides being quicker & easier) than other such approaches.

Thanks for this as well. I have made several changes to the paper, particularly to the summary and statement of need, to give readers a clearer understanding of the basic problems and how gaussplotR can provide the tools to solve them. Thanks also for catching the typos re: references and for motivating me to find additional references to showcase the applicability of 2D-Gaussians.

@cddesja

A couple of references need to be fixed, line 14 and line 30.

Thanks for catching this. I believe I have now caught the errors in reference formatting.

The last sentence of the paper you may want to change the word "the" to "an"

I've opted to rephrase the last part of the sentence to give a couple more details.

As @brunaw stated there's no contribution guide.

Thanks -- as noted above, I have added a section to the README.

I do suspect there are some 2d Gaussian packages in R that could be cited as relevant, if not providing, similar functionality. A quick search finds package with similar names.

Thanks, I agree. I have added a citation to the imagefx package, given what imagefx::build.gaus() is capable of performing. I also note what stats::nls() can achieve, though it is not strictly limited to estimating parameters for 2D-Gaussians. Please let me know if you had any other packages in mind -- I have not found any others that are relevant.

I think it would be beneficial to list all the package requirements on your GitHub site.

With all due respect, I disagree. This is not a standard practice, and I have only seen it done on the rare occasion that a package has strict requirements (e.g. needing a java installation on the computer, only working on MacOS, etc). Moreover, the requirements for gaussplotR are pretty light; there are only four dependencies, two of which are very likely to already be on a user's machine. Please also note that following your & @brunaw's advice, I have relaxed the requirement of R >= 4.0.0, as I agree it is definitely not necessary.

I really appreciate the way that the package allows for easy use with ggplot2 and lattice.

Thanks!

I am not sure that I agree with @brunaw about whether you need to change the R requirements to allow for R less than 4. While I totally agree with her rationale, I don't think it's necessarily your responsibility to make sure that the package is backwards compatible. However, if @brunaw feels strongly about this, then I think the request is more than reasonable.

As noted above, I am comfortable with relaxing this requirement. It was not necessary and I thank you @brunaw for catching it

Regarding @brunaw request about the statement of need and the summary section, would it be possible to walk the reader through an applied application of your package? For example, you reference an in-press paper, could you walk us through the problem you encountered and how your package helped to solve it in non-technical language?

I have made large revisions to the beginning of the paper. From the outset, I have added an explanation of how 2D-Gaussians are used in Priebe et al., 2003 in relatively non-technical language. I would prefer to not go into detail about our in-prep paper, though I will note that much of the analysis in it follow methods used by Priebe et al. So I am hoping that with the revisions I've made to the summary and statement of need, I have now made the motivation behind writing gaussplotR and how it is useful more clear to the reader. Does that sound ok?

Thanks again to both of you!

Best regards,
Vikram
🐢

@cddesja
Copy link

cddesja commented Mar 19, 2021

@vbaliga, I am fine with your changes. Regarding

I think it would be beneficial to list all the package requirements on your GitHub site.

I was just basing this off the Installation Instruction checklist. I agree that your package has few requirements and If the user does want to see them they can visit: https://cran.r-project.org/web/packages/gaussplotR/index.html

@whedon
Copy link
Author

whedon commented Apr 1, 2021 

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

OK DOIs

- 10.1152/jn.1994.71.6.2517 is OK
- 10.2528/pier97071100 is OK
- 10.1016/S0141-8130(98)00084-1 is OK
- 10.1523/JNEUROSCI.23-13-05650.2003 is OK
- 10.1016/j.wavemoti.2003.12.012 is OK
- 10.1152/jn.00921.2005 is OK
- 10.1109/EUROCON.2013.6625198 is OK
- 10.1109/ICACCI.2013.6637241 is OK
- 10.1016/j.optlastec.2018.07.049 is OK
- 10.1016/j.media.2020.101897 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Apr 1, 2021

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

@KristinaRiemer
Copy link

Great, thanks for doing that @vbaliga! So we want the archived code to match the submission, so could you change the title on Zenodo to "gaussplotR: Fit, Predict and Plot 2D-Gaussians in R"?

@vbaliga
Copy link

vbaliga commented Apr 1, 2021

@KristinaRiemer sure thing! I just pushed an update to Zenodo (v0.2.5, see: https://doi.org/10.5281/zenodo.4657750). The corresponding release on the github repo is available here: https://github.com/vbaliga/gaussplotR/releases/tag/v0.2.5

@danielskatz
Copy link

@KristinaRiemer - is this ready for you to recommend acceptance at this point?

@KristinaRiemer
Copy link

@whedon set 10.5281/zenodo.4657750 as archive

@whedon
Copy link
Author

whedon commented Apr 6, 2021

OK. 10.5281/zenodo.4657750 is the archive.

@KristinaRiemer
Copy link

@whedon set v0.2.5 as version

@whedon
Copy link
Author

whedon commented Apr 6, 2021

OK. v0.2.5 is the version.

@KristinaRiemer
Copy link

@whedon accept

@whedon
Copy link
Author

whedon commented Apr 6, 2021 

Attempting dry run of processing paper acceptance...

@whedon whedon added the recommend-accept Papers recommended for acceptance in JOSS. label Apr 6, 2021
@whedon
Copy link
Author

whedon commented Apr 6, 2021 

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

OK DOIs

- 10.1152/jn.1994.71.6.2517 is OK
- 10.2528/pier97071100 is OK
- 10.1016/S0141-8130(98)00084-1 is OK
- 10.1523/JNEUROSCI.23-13-05650.2003 is OK
- 10.1016/j.wavemoti.2003.12.012 is OK
- 10.1152/jn.00921.2005 is OK
- 10.1109/EUROCON.2013.6625198 is OK
- 10.1109/ICACCI.2013.6637241 is OK
- 10.1016/j.optlastec.2018.07.049 is OK
- 10.1016/j.media.2020.101897 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Apr 6, 2021

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

Check final proof 👉 openjournals/joss-papers#2197

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#2197, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.

@whedon accept deposit=true

@danielskatz
Copy link

👋 @vbaliga - there are two small changes in vbaliga/gaussplotR#1 - if you can merge this, we should be able to proceed to publication.

@danielskatz
Copy link

@whedon accept

@whedon
Copy link
Author

whedon commented Apr 6, 2021 

Attempting dry run of processing paper acceptance...

@whedon
Copy link
Author

whedon commented Apr 6, 2021 

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

OK DOIs

- 10.1152/jn.1994.71.6.2517 is OK
- 10.2528/pier97071100 is OK
- 10.1016/S0141-8130(98)00084-1 is OK
- 10.1523/JNEUROSCI.23-13-05650.2003 is OK
- 10.1016/j.wavemoti.2003.12.012 is OK
- 10.1152/jn.00921.2005 is OK
- 10.1109/EUROCON.2013.6625198 is OK
- 10.1109/ICACCI.2013.6637241 is OK
- 10.1016/j.optlastec.2018.07.049 is OK
- 10.1016/j.media.2020.101897 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Apr 6, 2021

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

Check final proof 👉 openjournals/joss-papers#2202

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#2202, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.

@whedon accept deposit=true

@danielskatz
Copy link

@whedon accept deposit=true

@whedon
Copy link
Author

whedon commented Apr 6, 2021 

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

@whedon whedon added accepted published Papers published in JOSS labels Apr 6, 2021
@whedon
Copy link
Author

whedon commented Apr 6, 2021

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

@whedon
Copy link
Author

whedon commented Apr 6, 2021

🚨🚨🚨 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.03074 joss-papers#2203
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.03074
  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...

@danielskatz
Copy link

Congratulations to @vbaliga (Vikram B. Baliga)!!

And thanks to @cddesja and @brunaw for reviewing, and @KristinaRiemer for editing!

@whedon
Copy link
Author

whedon commented Apr 6, 2021

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

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

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

This is how it will look in your documentation:

DOI

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:

@vbaliga
Copy link

vbaliga commented Apr 6, 2021

@danielskatz and @KristinaRiemer -- thank you so much!

@editorialbot editorialbot mentioned this issue Jan 20, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cddesja cddesja

@KristinaRiemer KristinaRiemer

@brunaw brunaw

Labels
accepted HTML published Papers published in JOSS R recommend-accept Papers recommended for acceptance in JOSS. review TeX
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@cddesja @danielskatz @KristinaRiemer @vbaliga @brunaw @whedon