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]: Can you predict the future? A tutorial for the National Ecological Observatory Network Ecological Forecasting Challenge #259

Closed
editorialbot opened this issue Sep 16, 2024 · 64 comments
Labels
accepted published Papers published in JOSE R recommend-accept Papers recommended for acceptance in JOSE. review TeX

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Sep 16, 2024

Submitting author: @OlssonF (Freya Olsson)
Repository: https://github.com/eco4cast/NEON-forecast-challenge-workshop
Branch with paper.md (empty if default branch): main
Version: v1.3.1
Editor: @acocac
Reviewers: @dlebauer, @skmorgane
Archive: 10.5281/zenodo.14018090
Paper kind: learning module

Status

status

Status badge code:

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

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

@dlebauer & @acocac, 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://openjournals.readthedocs.io/en/jose/reviewer_guidelines.html. Any questions/concerns please let @acocac 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 @dlebauer

📝 Checklist for @skmorgane

@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

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

✅ OK DOIs

- 10.5281/zenodo.8316965 is OK
- 10.1002/fee.2616 is OK
- 10.1002/ecs2.2567 is OK
- 10.21105/joss.01686 is OK
- 10.1073/pnas.1710231115 is OK
- 10.1111/2041-210X.13955 is OK
- 10.1515/9781400885459 is OK
- 10.21105/jose.00198 is OK

🟡 SKIP DOIs

- None

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.90  T=0.02 s (755.2 files/s, 241591.4 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Markdown                         5            464              0           1822
Rmd                              3            366            648            511
R                                3             53             44            114
TeX                              1              9              0            105
YAML                             1              1              4             18
-------------------------------------------------------------------------------
SUM:                            13            893            696           2570
-------------------------------------------------------------------------------

Commit count by author:

   151	LAPTOP-FO87M896reya
    28	Freya Olsson
     4	rqthomas
     3	github-actions
     2	Cayelan Carey
     1	Carl Boettiger
     1	Mary Lofton
     1	Quinn Thomas
     1	QuinnThomas

@editorialbot
Copy link
Collaborator Author

Paper file info:

📄 Wordcount for paper.md is 1662

✅ The paper includes a Statement of need section

@editorialbot
Copy link
Collaborator Author

License info:

✅ License found: MIT License (Valid open source OSI approved license)

@editorialbot
Copy link
Collaborator Author

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

@acocac
Copy link

acocac commented Sep 23, 2024

@editorialbot add @skmorgane as reviewer

@editorialbot
Copy link
Collaborator Author

@skmorgane added to the reviewers list!

@acocac
Copy link

acocac commented Sep 23, 2024

@editorialbot remove @acocac as reviewer

@editorialbot
Copy link
Collaborator Author

@acocac removed from the reviewers list!

@acocac
Copy link

acocac commented Sep 23, 2024

Hi @OlssonF
fyi - I got a late reply from one of your suggested reviewers, Morgan Ernest, who has confirmed availability within a time period of 3 weeks. I hope this is fine for you. I'll remove myself from the reviewer list.

@acocac
Copy link

acocac commented Sep 23, 2024

👋 @dlebauer @skmorgane we will conduct the review in this issue.

Please read through the above information and let me know if you have any questions about the review process.

Thank you 🙏

@dlebauer
Copy link

dlebauer commented Sep 30, 2024

Review checklist for @dlebauer

Conflict of interest

Code of Conduct

General checks

  • Repository: Is the source for this learning module available at the https://github.com/OlssonF/NEON-forecast-challenge-workshop?
  • License: Does the repository contain a plain-text LICENSE file with the contents of a standard license? (OSI-approved for code, Creative Commons for content)
  • Version: Does the release version given match the repository release?
  • Authorship: Has the submitting author (@OlssonF) made visible contributions to the module? Does the full list of authors seem appropriate and complete?

Documentation

  • A statement of need: Do the authors clearly state the need for this module and who the target audience is?
  • Installation instructions: Is there a clearly stated list of dependencies?
  • Usage: Does the documentation explain how someone would adopt the module, and include examples of how to use it?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the module 2) Report issues or problems with the module 3) Seek support

Pedagogy / Instructional design (Work-in-progress: reviewers, please comment!)

  • Learning objectives: Does the module make the learning objectives plainly clear? (We don't require explicitly written learning objectives; only that they be evident from content and design.)
  • Content scope and length: Is the content substantial for learning a given topic? Is the length of the module appropriate?
  • Pedagogy: Does the module seem easy to follow? Does it observe guidance on cognitive load? (working memory limits of 7 +/- 2 chunks of information)
  • Content quality: Is the writing of good quality, concise, engaging? Are the code components well crafted? Does the module seem complete?
  • Instructional design: Is the instructional design deliberate and apparent? For example, exploit worked-example effects; effective multi-media use; low extraneous cognitive load.

JOSE paper

  • Authors: Does the paper.md file include a list of authors with their affiliations?
  • A statement of need: Does the paper clearly state the need for this module and who the target audience is?
  • Description: Does the paper describe the learning materials and sequence?
  • Does it describe how it has been used in the classroom or other settings, and how someone might adopt it?
  • Could someone else teach with this module, given the right expertise?
  • Does the paper tell the "story" of how the authors came to develop it, or what their expertise is?
  • References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?

@dlebauer
Copy link

@acocac Could you please help me understand the version requirement "Does the release version given match the repository release?" - the latest release in the repository is v1.2.0, this issue lists it as v1.1.0. It isn't clear to me which version the proof is from, though I suspect any changes will at least bump the version.

--> I think it would be helpful to clarify this part of the checklist and reviewer instructions

@acocac
Copy link

acocac commented Oct 1, 2024

@editorialbot commands

@editorialbot
Copy link
Collaborator Author

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


# List all available commands
@editorialbot commands

# Add to this issue's reviewers list
@editorialbot add @username as reviewer

# Remove from this issue's reviewers list
@editorialbot remove @username from reviewers

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

# Assign a user as the editor of this submission
@editorialbot assign @username as editor

# Remove the editor assigned to this submission
@editorialbot remove editor

# Remind an author, a reviewer or the editor to return to a review after a 
# certain period of time (supported units days and weeks)
@editorialbot remind @reviewer in 2 weeks

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

# Set a value for version
@editorialbot set v1.0.0 as version

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

# Set a value for repository
@editorialbot set https://github.com/organization/repo as repository

# Set a value for the archive DOI
@editorialbot set 10.5281/zenodo.6861996 as archive

# Mention the EiCs for the correct track
@editorialbot ping track-eic

# Run checks and provide information on the repository and the paper file
@editorialbot check repository

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

# Generates the pdf paper
@editorialbot generate pdf

# Recommends the submission for acceptance
@editorialbot recommend-accept

# Generates a LaTeX preprint file
@editorialbot generate preprint

# Flag submission with questionable scope
@editorialbot query scope

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

# Creates a post-review checklist with editor and authors tasks
@editorialbot create post-review checklist

# Open the review issue
@editorialbot start review

@acocac
Copy link

acocac commented Oct 1, 2024

@editorialbot set v1.2.0 as version

@editorialbot
Copy link
Collaborator Author

Done! version is now v1.2.0

@acocac
Copy link

acocac commented Oct 1, 2024

@acocac Could you please help me understand the version requirement "Does the release version given match the repository release?" - the latest release in the repository is v1.2.0, this issue lists it as v1.1.0. It isn't clear to me which version the proof is from, though I suspect any changes will at least bump the version.

--> I think it would be helpful to clarify this part of the checklist and reviewer instructions

@dlebauer - I've fixed the issue. The revision should be on the latest release.

@skmorgane
Copy link

skmorgane commented Oct 4, 2024

Review checklist for @skmorgane

Conflict of interest

Code of Conduct

General checks

  • Repository: Is the source for this learning module available at the https://github.com/OlssonF/NEON-forecast-challenge-workshop?
  • License: Does the repository contain a plain-text LICENSE file with the contents of a standard license? (OSI-approved for code, Creative Commons for content)
  • Version: Does the release version given match the repository release?
  • Authorship: Has the submitting author (@OlssonF) made visible contributions to the module? Does the full list of authors seem appropriate and complete?

Documentation

  • A statement of need: Do the authors clearly state the need for this module and who the target audience is?
  • Installation instructions: Is there a clearly stated list of dependencies?
  • Usage: Does the documentation explain how someone would adopt the module, and include examples of how to use it?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the module 2) Report issues or problems with the module 3) Seek support

Pedagogy / Instructional design (Work-in-progress: reviewers, please comment!)

  • Learning objectives: Does the module make the learning objectives plainly clear? (We don't require explicitly written learning objectives; only that they be evident from content and design.)
  • Content scope and length: Is the content substantial for learning a given topic? Is the length of the module appropriate?
  • Pedagogy: Does the module seem easy to follow? Does it observe guidance on cognitive load? (working memory limits of 7 +/- 2 chunks of information)
  • Content quality: Is the writing of good quality, concise, engaging? Are the code components well crafted? Does the module seem complete?
  • Instructional design: Is the instructional design deliberate and apparent? For example, exploit worked-example effects; effective multi-media use; low extraneous cognitive load.

JOSE paper

  • Authors: Does the paper.md file include a list of authors with their affiliations?
  • A statement of need: Does the paper clearly state the need for this module and who the target audience is?
  • Description: Does the paper describe the learning materials and sequence?
  • Does it describe how it has been used in the classroom or other settings, and how someone might adopt it?
  • Could someone else teach with this module, given the right expertise?
  • Does the paper tell the "story" of how the authors came to develop it, or what their expertise is?
  • References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?

@skmorgane
Copy link

@acocac I started my review by making sure I didn't have conflicts with the full author list but realized that two of the authors I have an association with that I should disclose: Carey and Thomas. We are coauthors on a large author line paper that was just accepted. I think this one falls under "co-authors but not really collaborating" in the guidelines and is probably not a concern. However, we are also collaborating on a proposal, again a large multi-investigator/multi-institutional effort, but we do interact a little more directly there. I think I can review this impartially, but if the association violates JOSE rules, I have two people I can recommend as reviewers who I know are not interacting with anyone on the author line. Just let me know how you would like to proceed

dlebauer added a commit to dlebauer/NEON-forecast-challenge-workshop that referenced this issue Oct 7, 2024
While reviewing for openjournals/jose-reviews#259 I found a few changes to suggest:

I added a few hyperlinks to local files - however it is done, I think that when files are referenced it should be clear to the reader where to find them - even if they are in the root directory, but especially if not.  

Should Rstudio be listed as a requirement? The first to methods under getting the code assume it is installed. 

This also fixes a few typos
@OlssonF
Copy link

OlssonF commented Oct 22, 2024

@OlssonF thanks for confirm the successful transfer of the repository. May I ask if you update the paper too? It still points to the previous GitHub repository, https://github.com/OlssonF/NEON-forecast-challenge-workshop. Please commit/push the updated paper and release a version accordingly. Thank you 🙏

Thanks! We have updated the paper and release (https://github.com/eco4cast/NEON-forecast-challenge-workshop/releases/tag/v1.3.1)

@acocac
Copy link

acocac commented Oct 23, 2024

@editorialbot set v1.3.1 as version

@editorialbot
Copy link
Collaborator Author

Done! version is now v1.3.1

@acocac
Copy link

acocac commented Oct 30, 2024

Post-Review Checklist for Editor and Authors

Additional Author Tasks After Review is Complete

  • Double check authors and affiliations (including ORCIDs)
  • Make a release of the software with the latest changes from the review and post the version number here. This is the version that will be used in the JOSE paper.
  • Archive the release on Zenodo/figshare/etc and post the DOI here.
  • Make sure that the title and author list (including ORCIDs) in the archive match those in the JOSE paper.
  • Make sure that the license listed for the archive is the same as the software license.

Editor Tasks Prior to Acceptance

  • Read the text of the paper and offer comments/corrections (as either a list or a PR)
  • Check the references in the paper for corrections (e.g. capitalization)
  • Check that the archive title, author list, version tag, and the license are correct
  • Set archive DOI with @editorialbot set <DOI here> as archive
  • Set version with @editorialbot set <version here> as version
  • Double check rendering of paper with @editorialbot generate pdf
  • Specifically check the references with @editorialbot check references and ask author(s) to update as needed
  • Recommend acceptance with @editorialbot recommend-accept

@acocac
Copy link

acocac commented Oct 30, 2024

@OlssonF prior to acceptance of the submission, I kindly ask your help to complete the additional author tasks i.e. checklist above.

@OlssonF
Copy link

OlssonF commented Oct 31, 2024

  • Double check authors and affiliations (including ORCIDs)
  • Make a release of the software with the latest changes from the review and post the version number here. This is the version that will be used in the JOSE paper.
  • Archive the release on Zenodo/figshare/etc and post the DOI here.
  • Make sure that the title and author list (including ORCIDs) in the archive match those in the JOSE paper.
  • Make sure that the license listed for the archive is the same as the software license.

The latest software release is v1.3.1 (https://github.com/eco4cast/NEON-forecast-challenge-workshop/releases/tag/v1.3.1) and the Zenodo DOI is https://doi.org/10.5281/zenodo.14018090. I have checked and updated the Zenodo archive title and authorship and updated the license to match the GitHub repository (MIT license)
Thanks @acocac

@acocac
Copy link

acocac commented Nov 1, 2024

@editorialbot check references

@editorialbot
Copy link
Collaborator Author

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

✅ OK DOIs

- 10.5281/zenodo.8316965 is OK
- 10.1002/fee.2616 is OK
- 10.1002/ecs2.2567 is OK
- 10.21105/joss.01686 is OK
- 10.1073/pnas.1710231115 is OK
- 10.1111/2041-210X.13955 is OK
- 10.1515/9781400885459 is OK
- 10.21105/jose.00198 is OK

🟡 SKIP DOIs

- None

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@acocac
Copy link

acocac commented Nov 1, 2024

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@acocac
Copy link

acocac commented Nov 1, 2024

@editorialbot
Copy link
Collaborator Author

Done! archive is now 10.5281/zenodo.14018090

@acocac
Copy link

acocac commented Nov 1, 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.5281/zenodo.8316965 is OK
- 10.1002/fee.2616 is OK
- 10.1002/ecs2.2567 is OK
- 10.21105/joss.01686 is OK
- 10.1073/pnas.1710231115 is OK
- 10.1111/2041-210X.13955 is OK
- 10.1515/9781400885459 is OK
- 10.21105/jose.00198 is OK

🟡 SKIP DOIs

- None

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👋 @openjournals/jose-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/jose-papers#159, 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 JOSE. label Nov 1, 2024
@OlssonF
Copy link

OlssonF commented Nov 4, 2024

Looks good to me @acocac is there anything I need to do?

@acocac
Copy link

acocac commented Nov 14, 2024

@labarba waiting the final approval. Everything looks ok according to the post-review checklist.

@labarba
Copy link
Member

labarba commented Nov 14, 2024

patience requested. traveling

@labarba
Copy link
Member

labarba commented Dec 26, 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: Olsson
  given-names: Freya
  orcid: "https://orcid.org/0000-0002-0483-4489"
- family-names: Boettiger
  given-names: Carl
  orcid: "https://orcid.org/0000-0002-1642-628X"
- family-names: Carey
  given-names: Cayelan C.
  orcid: "https://orcid.org/0000-0001-8835-4476"
- family-names: Lofton
  given-names: Mary E.
  orcid: "https://orcid.org/0000-0003-3270-1330"
- family-names: Thomas
  given-names: R. Quinn
  orcid: "https://orcid.org/0000-0003-1282-7825"
doi: 10.5281/zenodo.14018090
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Olsson
    given-names: Freya
    orcid: "https://orcid.org/0000-0002-0483-4489"
  - family-names: Boettiger
    given-names: Carl
    orcid: "https://orcid.org/0000-0002-1642-628X"
  - family-names: Carey
    given-names: Cayelan C.
    orcid: "https://orcid.org/0000-0001-8835-4476"
  - family-names: Lofton
    given-names: Mary E.
    orcid: "https://orcid.org/0000-0003-3270-1330"
  - family-names: Thomas
    given-names: R. Quinn
    orcid: "https://orcid.org/0000-0003-1282-7825"
  date-published: 2024-12-26
  doi: 10.21105/jose.00259
  issn: 2577-3569
  issue: 82
  journal: Journal of Open Source Education
  publisher:
    name: Open Journals
  start: 259
  title: Can you predict the future? A tutorial for the National
    Ecological Observatory Network Ecological Forecasting Challenge
  type: article
  url: "https://jose.theoj.org/papers/10.21105/jose.00259"
  volume: 7
title: Can you predict the future? A tutorial for the National
  Ecological Observatory Network Ecological Forecasting Challenge

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

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

@editorialbot
Copy link
Collaborator Author

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

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited 👉 Creating pull request for 10.21105.jose.00259 jose-papers#167
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/jose.00259
  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 JOSE labels Dec 26, 2024
@labarba
Copy link
Member

labarba commented Dec 26, 2024

Congratulations @OlssonF – your JOSE paper is published! 🚀

Huge thanks to our Editor: @acocac and Reviewers: @dlebauer, @skmorgane – your contributions make this possible 🙏

@labarba labarba closed this as completed Dec 26, 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://jose.theoj.org/papers/10.21105/jose.00259/status.svg)](https://doi.org/10.21105/jose.00259)

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

reStructuredText:
.. image:: https://jose.theoj.org/papers/10.21105/jose.00259/status.svg
   :target: https://doi.org/10.21105/jose.00259

This is how it will look in your documentation:

DOI

We need your help!

The Journal of Open Source Education 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:

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

No branches or pull requests

6 participants