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]: Shiny tools for management rules: interactive applications that aid in conservation strategies for North Atlantic right whales #5436

Closed
editorialbot opened this issue May 3, 2023 · 69 comments
Assignees
Labels
accepted HTML published Papers published in JOSS R recommend-accept Papers recommended for acceptance in JOSS. review Standard ML Track: 6 (ESE) Earth Sciences and Ecology

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented May 3, 2023

Submitting author: @leahcrowe (Leah Crowe)
Repository: https://github.com/NEFSC/READ-PSB-LWT-narwss_rwsas_apps
Branch with paper.md (empty if default branch):
Version: v1.1.0
Editor: @graciellehigino
Reviewers: @TanyaS08, @salix-d
Archive: 10.5281/zenodo.8127594

Status

status

Status badge code:

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

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

@TanyaS08 & @salix-d, 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 @graciellehigino 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 @TanyaS08

📝 Checklist for @salix-d

@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.04 s (1401.2 files/s, 206604.8 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
R                               27            724            478           4914
XML                             12              0              1            757
HTML                             1             48              0            634
TeX                              3             44              7            293
Markdown                         2             43              0            112
Standard ML                      2              0              0            107
Rmd                              9             54            252             48
YAML                             2              3              4             29
-------------------------------------------------------------------------------
SUM:                            58            916            742           6894
-------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@editorialbot
Copy link
Collaborator Author

Wordcount for paper.md is 1444

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.1016/j.marpol.2019.02.019 is OK
- 10.3354/dao03376 is OK
- 10.1111/2041-210x.13244 is OK
- 10.3354/esr00368 is OK
- 10.5670/oceanog.2021.308 is OK
- 10.21105/joss.03094 is OK
- 10.3389/fmars.2021.760840 is OK

MISSING DOIs

- 10.1575/1912/29599 may be a valid DOI for title: North Atlantic Right Whale Consortium 2021 Annual Report Card

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

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

@graciellehigino
Copy link

graciellehigino commented May 3, 2023

Hi all! Welcome to the review thread! 🎉

While our excellent reviewers gather their comments, could you please double-check the missing DOIs on the paper, @leahcrowe? Thanks!

@TanyaS08 and @salix-d - thank you so much for accepting to be part of this discussion! As the bot has mentioned, you can learn more about the review process here. Do not hesitate to contact me if you need anything. [=

@TanyaS08
Copy link

TanyaS08 commented May 4, 2023

Review checklist for @TanyaS08

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/NEFSC/READ-PSB-LWT-narwss_rwsas_apps?
  • 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 (@leahcrowe) 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
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

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, who the target audience is, and its relation to other work?
  • 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?

@leahcrowe
Copy link

@editorialbot generate pdf

DOIs updated!

@editorialbot
Copy link
Collaborator Author

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

@salix-d
Copy link

salix-d commented May 7, 2023

Review checklist for @salix-d

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/NEFSC/READ-PSB-LWT-narwss_rwsas_apps?
  • 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 (@leahcrowe) 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
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

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, who the target audience is, and its relation to other work?
  • 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?

@salix-d
Copy link

salix-d commented May 9, 2023

Hi!

I was trying to test the functionnality with the example_data/20210409.
I found the documentation wiki to be quite clear, and was easily able to follow along. However, I was missing some information to be able to test fully.

I checked 'local' and entered the path where I saved the files in that folder, entered '210409' as the 'Survey Date', but I couldn't find the 'Tail number'. I tried without and got the error:

Uh oh! Those files can't be found! Double check your connection to the network, the local network pathway, your data, and/or your survey date entry.
whether 'Edited eff/sig files' had 'yes' or 'no' selected.

Do you have the tail number somewhere in this repo?
If not, I would add it in a text file in the 'example_data/20210409' folder.

Another thing is that you need an 'Example usage'. I think you could easily add with the example data so people can get a feel of what can be done.

Thanks!

@TanyaS08
Copy link

TanyaS08 commented May 9, 2023

I'm going to attach/insert myself here as well since I had the same issue (I also added some dummy digits for a flight number - same message). I was wondering if it might also be an OS issue when setting the path? I'm running macOS for what it's worth...

@salix-d
Copy link

salix-d commented May 9, 2023

And I'm on windows.

( kinda nice we cover multiple OS to test :) )

@leahcrowe
Copy link

Hi all,

Thank you for agreeing to test this app. We are grateful for your involvement and review!

You don't need to include a tail number to proceed, but I have updated the wiki page with an example tail number: https://github.com/NEFSC/READ-PSB-LWT-narwss_rwsas_apps/wiki/Aerial-Survey-Processing-App,-Aerial-Survey-Tab:-Part-1

The issue you all were running into was that I incorrectly named the folder containing the example data (was YYYYMMDD when it should have been YYMMDD). All good now, and I have updated the README file with how to run the example data (without needing to download anything to your machine).

I'm aware that you all will not be able to test the trigger evaluation without access to our database server, so I am working on an example workaround.

Hopefully at least the processing app goes a bit more smoothly for you -- sorry about that mix up!

Leah

@salix-d
Copy link

salix-d commented May 9, 2023

The problem was that I thought the path to the files included the folder 210409 and/or that they needed to be in a folder named with the date.

Perhaps " the pathway you enter should be the pathway where the edit files are stored." could be change to something like " the pathway you enter should be the pathway to the folder containing the edit files are stored. This file should also be labeled like [YYMMDD]."

@salix-d
Copy link

salix-d commented May 9, 2023

For the dependencies, I notice that if I don't load the libraries, they get loaded when doing shiny::runGitHub("READ-PSB-LWT-narwss_rwsas_apps", username = "NEFSC", ref = "master") so the user doesn't have to copy the list from the readme.

Since the review check list mentionned that

Ideally these should be handled with an automated package management solution.

I would suggest using require instead of library in the global_libraries.R script. This will install any missing packages for the user.

@salix-d
Copy link

salix-d commented May 9, 2023

I was able to download the report in html but not in pdf format.

I had this error :

An error has occurred!
LaTeX failed to compile C:\Users\salix\AppData\Local\Temp\RtmpwVL36t\file39543fa5181d.tex. See https://yihui.org/tinytex/r/#debugging for debugging tips. See file39543fa5181d.log for more info.

Here's the log file:
file39543fa5181d.log

Don't know if related, but the html file was named "09Apr2021_NOAA_NERW_Aerial_Report.html" and the pdf file "report.htm".

@leahcrowe
Copy link

I was able to download the report in html but not in pdf format.

I had this error :

An error has occurred!
LaTeX failed to compile C:\Users\salix\AppData\Local\Temp\RtmpwVL36t\file39543fa5181d.tex. See https://yihui.org/tinytex/r/#debugging for debugging tips. See file39543fa5181d.log for more info.

Here's the log file: file39543fa5181d.log

Don't know if related, but the html file was named "09Apr2021_NOAA_NERW_Aerial_Report.html" and the pdf file "report.htm".

This is an issue that occurs related to tinytex/your machine's LaTeX distribution. I offer up some tests/installation instructions in the "Additional installation" README section. I have been able to set this up on several different computers and our shiny server, but some computers have eluded me, which is why we have offered the html download option. The correct naming convention is added to the file when it works properly.

@leahcrowe
Copy link

Hi all,

I've added in three more example days of data that offer different scenarios for the trigger analysis from the aerial survey data (see the README file for the update). For our functional operations, we have this app interacting on our internal server and database, so I can't offer up that actual experience, but I hope the examples I have provided demonstrate how this app is going through the decision making process for triggering protection zones, or not. Please let me know if there is anything further you would like to see to proceed.

Leah

@TanyaS08
Copy link

I was able to download the report in html but not in pdf format.
I had this error :

An error has occurred!
LaTeX failed to compile C:\Users\salix\AppData\Local\Temp\RtmpwVL36t\file39543fa5181d.tex. See https://yihui.org/tinytex/r/#debugging for debugging tips. See file39543fa5181d.log for more info.

Here's the log file: file39543fa5181d.log
Don't know if related, but the html file was named "09Apr2021_NOAA_NERW_Aerial_Report.html" and the pdf file "report.htm".

This is an issue that occurs related to tinytex/your machine's LaTeX distribution. I offer up some tests/installation instructions in the "Additional installation" README section. I have been able to set this up on several different computers and our shiny server, but some computers have eluded me, which is why we have offered the html download option. The correct naming convention is added to the file when it works properly.

I've also had an issue with creating the PDF (but everything else works! 😊). My error message looks a bit different though and says the following:
I was unable to find any missing LaTeX packages from the error log file947ed0e2974.log.
! Undefined control sequence.
l.81 title: ``NOAA Northeast Region \nRight
Whale Aerial Survey Report''

which is then followed by:

Warning: Error in : LaTeX failed to compile /var/folders/wf/wmp7x6xj7_zbx2bl9z5ysfwm0000gn/T//Rtmpuirwmm/file947ed0e2974.tex. See https://yihui.org/tinytex/r/#debugging for debugging tips. See file947ed0e2974.log for more info.

It could be that I also have an underlying LATEX issue but I was wondering about the l.81 title: ``NOAA Northeast Region \nRight Whale Aerial Survey Report'' comment...

@leahcrowe
Copy link

I was able to download the report in html but not in pdf format.
I had this error :

An error has occurred!
LaTeX failed to compile C:\Users\salix\AppData\Local\Temp\RtmpwVL36t\file39543fa5181d.tex. See https://yihui.org/tinytex/r/#debugging for debugging tips. See file39543fa5181d.log for more info.

Here's the log file: file39543fa5181d.log
Don't know if related, but the html file was named "09Apr2021_NOAA_NERW_Aerial_Report.html" and the pdf file "report.htm".

This is an issue that occurs related to tinytex/your machine's LaTeX distribution. I offer up some tests/installation instructions in the "Additional installation" README section. I have been able to set this up on several different computers and our shiny server, but some computers have eluded me, which is why we have offered the html download option. The correct naming convention is added to the file when it works properly.

I've also had an issue with creating the PDF (but everything else works! 😊). My error message looks a bit different though and says the following: I was unable to find any missing LaTeX packages from the error log file947ed0e2974.log. ! Undefined control sequence. l.81 title: ``NOAA Northeast Region \nRight Whale Aerial Survey Report''

which is then followed by:

Warning: Error in : LaTeX failed to compile /var/folders/wf/wmp7x6xj7_zbx2bl9z5ysfwm0000gn/T//Rtmpuirwmm/file947ed0e2974.tex. See https://yihui.org/tinytex/r/#debugging for debugging tips. See file947ed0e2974.log for more info.

It could be that I also have an underlying LATEX issue but I was wondering about the l.81 title:NOAA Northeast Region \nRight Whale Aerial Survey Report'' `` comment...

I am thinking this has to do with your LaTeX distribution and if it recognizes "\n" as a line break or if it is looking for a different command. Likely it doesn't like the single "" in how your machine is set up. Our team just compiled the attached report the other day, so we do have this up and running properly on our server, but it's also exactly why we also offer the html option!

09May2023_NOAA_NERW_Aerial_Report.pdf

@TanyaS08
Copy link

I was able to download the report in html but not in pdf format.
I had this error :

An error has occurred!
LaTeX failed to compile C:\Users\salix\AppData\Local\Temp\RtmpwVL36t\file39543fa5181d.tex. See https://yihui.org/tinytex/r/#debugging for debugging tips. See file39543fa5181d.log for more info.

Here's the log file: file39543fa5181d.log
Don't know if related, but the html file was named "09Apr2021_NOAA_NERW_Aerial_Report.html" and the pdf file "report.htm".

This is an issue that occurs related to tinytex/your machine's LaTeX distribution. I offer up some tests/installation instructions in the "Additional installation" README section. I have been able to set this up on several different computers and our shiny server, but some computers have eluded me, which is why we have offered the html download option. The correct naming convention is added to the file when it works properly.

I've also had an issue with creating the PDF (but everything else works! 😊). My error message looks a bit different though and says the following: I was unable to find any missing LaTeX packages from the error log file947ed0e2974.log. ! Undefined control sequence. l.81 title: NOAA Northeast Region \nRight Whale Aerial Survey Report'' which is then followed by: Warning: Error in : LaTeX failed to compile /var/folders/wf/wmp7x6xj7_zbx2bl9z5ysfwm0000gn/T//Rtmpuirwmm/file947ed0e2974.tex. See https://yihui.org/tinytex/r/#debugging for debugging tips. See file947ed0e2974.log for more info. It could be that I also have an underlying LATEX issue but I was wondering about the `l.81 title:`NOAA Northeast Region \nRight Whale Aerial Survey Report'' comment...

I am thinking this has to do with your LaTeX distribution and if it recognizes "\n" as a line break or if it is looking for a different command. Likely it doesn't like the single "" in how your machine is set up. Our team just compiled the attached report the other day, so we do have this up and running properly on our server, but it's also exactly why we also offer the html option!

09May2023_NOAA_NERW_Aerial_Report.pdf

I'm wondering if there is a way to word this issue better in the README/wiki. I looked at it again and it is there but maybe in the README under the 'Additional installations' section it might be nice to have a sub-sub heading that is something along the lines of 'troubleshooting for PDF report generation'? And a phrase that echos what is in the README that PDF generation is hard but try these links for troubleshooting or generate the report as an .html and convert to PDF from there. Having just written that it might clog up the README so maybe even just a simple hyperlink linking to the wiki (https://github.com/NEFSC/READ-PSB-LWT-narwss_rwsas_apps/wiki/Aerial-Survey-Processing-App,-Aerial-Survey-Tab:-Part-3) to make the link more clear/make the user aware of this potential issue?

@TanyaS08
Copy link

TanyaS08 commented May 11, 2023

Hopefully I've done this right - I've opened an issue regarding documentation here:

NEFSC/READ-PSB-LWT-narwss_rwsas_apps#26

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.3354/esr01137 is OK
- 10.1016/j.marpol.2019.02.019 is OK
- 10.1575/1912/66099 is OK
- 10.3354/dao03376 is OK
- 10.1111/2041-210x.13244 is OK
- 10.3354/esr00368 is OK
- 10.1098/rsos.180892 is OK
- 10.1038/s41598-017-13359-3 is OK
- 10.5670/oceanog.2021.308 is OK
- 10.21105/joss.03094 is OK
- 10.3389/fmars.2021.760840 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@leahcrowe-otago
Copy link

Hi @leahcrowe ! Thank you so much for doing these checks with me. I've skimmed through the manuscript and I only noticed one thing that may be an error: one of the authors in this reference below has only their initials. Can you double-check that too? We're almost there! 🎉

Meyer-Gutbrod, E. L., Greene, C. H., Davies, K. T., & G, J. D. (2021). Ocean regime shift is driving collapse of the north atlantic right whale population. Oceanography. https://doi.org/10.5670/oceanog.2021.308

Nice catch! I just pushed the edit!

@graciellehigino
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@graciellehigino
Copy link

@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.3354/esr01137 is OK
- 10.1016/j.marpol.2019.02.019 is OK
- 10.1575/1912/66099 is OK
- 10.3354/dao03376 is OK
- 10.1111/2041-210x.13244 is OK
- 10.3354/esr00368 is OK
- 10.1098/rsos.180892 is OK
- 10.1038/s41598-017-13359-3 is OK
- 10.5670/oceanog.2021.308 is OK
- 10.21105/joss.03094 is OK
- 10.3389/fmars.2021.760840 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👋 @openjournals/ese-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#4409, 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 Jul 17, 2023
@kthyng
Copy link

kthyng commented Jul 19, 2023

Ok final checks:

  • Check that version was updated
  • Check that software archive exists, has been input to JOSS, and title and author list look good
  • Check paper

@kthyng
Copy link

kthyng commented Jul 19, 2023

@leahcrowe Please check the capitalization in your references. You can preserve capitalization by placing {} around characters/words in your .bib file.

@leahcrowe
Copy link

@kthyng Thanks for that catch! Should be good now!

@leahcrowe
Copy link

@kthyng is there anything more I should do after pushing that edit? Thanks for your help!

@kthyng
Copy link

kthyng commented Aug 1, 2023

@leahcrowe sorry I have been out of town since I wrote that. Catching up now.

@kthyng
Copy link

kthyng commented Aug 1, 2023

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@kthyng
Copy link

kthyng commented Aug 1, 2023

Ok looks ready to go!

@kthyng
Copy link

kthyng commented Aug 1, 2023

@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: Crowe
  given-names: Leah M.
  orcid: "https://orcid.org/0000-0001-9133-8522"
- family-names: Cole
  given-names: Tim V. N.
  orcid: "https://orcid.org/0000-0001-9046-2169"
- family-names: Foley
  given-names: Heather J.
  orcid: "https://orcid.org/0000-0003-0898-3008"
- family-names: Cholewiak
  given-names: Danielle M.
doi: 10.5281/zenodo.8127594
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Crowe
    given-names: Leah M.
    orcid: "https://orcid.org/0000-0001-9133-8522"
  - family-names: Cole
    given-names: Tim V. N.
    orcid: "https://orcid.org/0000-0001-9046-2169"
  - family-names: Foley
    given-names: Heather J.
    orcid: "https://orcid.org/0000-0003-0898-3008"
  - family-names: Cholewiak
    given-names: Danielle M.
  date-published: 2023-08-01
  doi: 10.21105/joss.05436
  issn: 2475-9066
  issue: 88
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 5436
  title: "Shiny tools for management rules: interactive applications
    that aid in conservation strategies for North Atlantic right whales"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.05436"
  volume: 8
title: "Shiny tools for management rules: interactive applications that
  aid in conservation strategies for North Atlantic right whales"

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.05436 joss-papers#4445
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.05436
  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 Aug 1, 2023
@kthyng
Copy link

kthyng commented Aug 1, 2023

Congrats on your new publication @leahcrowe! Many thanks to editor @graciellehigino and reviewers @TanyaS08 and @salix-d for your time, hard work, and expertise!!

@kthyng kthyng closed this as completed Aug 1, 2023
@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.05436/status.svg)](https://doi.org/10.21105/joss.05436)

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

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

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:

@leahcrowe
Copy link

Congrats on your new publication @leahcrowe! Many thanks to editor @graciellehigino and reviewers @TanyaS08 and @salix-d for your time, hard work, and expertise!!

Thank you to everyone! This was a great experience and we really appreciate the thoughtful reviews!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted HTML published Papers published in JOSS R recommend-accept Papers recommended for acceptance in JOSS. review Standard ML Track: 6 (ESE) Earth Sciences and Ecology
Projects
None yet
Development

No branches or pull requests

7 participants