Skip to content

[REVIEW]: LocalCop: An R package for local likelihood inference for conditional copulas #6744

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

Closed
editorialbot opened this issue May 13, 2024 · 66 comments
Assignees
Labels
accepted C++ published Papers published in JOSS R recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 5 (DSAIS) Data Science, Artificial Intelligence, and Machine Learning

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented May 13, 2024

Submitting author: @EFAcar (Elif Acar)
Repository: https://github.com/mlysy/LocalCop
Branch with paper.md (empty if default branch): joss
Version: v0.0.2
Editor: @lrnv
Reviewers: @AlexisDerumigny, @mingzehuang
Archive: 10.5281/zenodo.13801203

Status

status

Status badge code:

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

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

@AlexisDerumigny & @mingzehuang, 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 @lrnv 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 @mingzehuang

📝 Checklist for @AlexisDerumigny

@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.90  T=0.03 s (3100.3 files/s, 167245.8 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
R                               42            196            602           1181
C/C++ Header                    32            120            301            664
XML                              1              0              2            441
Markdown                         4             98              0            283
Rmd                              2             72            260            215
TeX                              2             31              8            148
C++                              4             12              9            134
YAML                             2             11              6             55
CSV                              1              0              0              6
-------------------------------------------------------------------------------
SUM:                            90            540           1188           3127
-------------------------------------------------------------------------------

Commit count by author:

    53	mlysy
    18	EFAcar
     6	Elif Fidan Acar
     1	alank2004

@editorialbot
Copy link
Collaborator Author

Paper file info:

📄 Wordcount for paper.md is 1625

✅ 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)

@editorialbot
Copy link
Collaborator Author

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

@lrnv
Copy link

lrnv commented May 13, 2024

👋🏼 @EFAcar, @AlexisDerumigny, @mingzehuang this is the review thread for the paper. All of our communications will happen here from now on.

@AlexisDerumigny, @mingzehuang, as reviewers, the first step is to create a checklist for your review by entering

@editorialbot generate my checklist

as the top of a new comment in this thread.

These checklists contain the JOSS requirements. As you go over the submission, please check any items that you feel have been satisfied. The first comment in this thread also contains links to the JOSS reviewer guidelines.

The JOSS review is different from most other journals. Our goal is to work with the authors to help them meet our criteria instead of merely passing judgment on the submission. As such, the reviewers are encouraged to submit issues and pull requests on the software repository. When doing so, please mention openjournals/joss-reviews#6744 so that a link is created to this thread (and I can keep an eye on what is happening). Please also feel free to comment and ask questions on this thread. In my experience, it is better to post comments/questions/suggestions as you come across them instead of waiting until you've reviewed the entire package.

We aim for reviews to be completed within about 2-4 weeks. Please let me know if any of you require some more time. We can also use EditorialBot (our bot) to set automatic reminders if you know you'll be away for a known period of time.

Please feel free to ping me (@lrnv) if you have any questions/concerns.

@editorialbot
Copy link
Collaborator Author

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

OK DOIs

- 10.1201/9781315370279 is OK
- 10.18637/jss.v070.i05 is OK
- 10.1016/j.ecosta.2019.03.002 is OK
- 10.1111/j.1541-0420.2010.01472.x is OK
- 10.1214/13-EJS866 is OK
- 10.18637/jss.v021.i04 is OK
- 10.18637/jss.v034.i09 is OK
- 10.18637/jss.v039.i09 is OK

MISSING DOIs

- No DOI given, and none found for title: LocalCop: LocalCop: Local Likelihood Inference for...
- No DOI given, and none found for title: copula: Multivariate Dependence with Copulas
- No DOI given, and none found for title: VineCopula: Statistical Inference of Vine Copulas
- No DOI given, and none found for title: gamCopula: Generalized Additive Models for Bivaria...
- No DOI given, and none found for title: CondCopulas: Estimation and Inference for Conditio...

INVALID DOIs

- None

@mingzehuang
Copy link

mingzehuang commented May 17, 2024

Review checklist for @mingzehuang

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/mlysy/LocalCop?
  • License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@EFAcar) 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?

@lrnv
Copy link

lrnv commented May 27, 2024

👋 @AlexisDerumigny & @mingzehuang How is it going with this review ? If you want/need, I could setup automatic reminders for you on this thread in like 1 week or 2. We usually aim at a 6-to-8 week reviewing time so you still have room ofc

@mingzehuang
Copy link

Thank you for your reminder, @lrnv ! It goes smoothly. And I can wrap it up very soon once the author addressed the issues I raised :)

@lrnv
Copy link

lrnv commented Jun 11, 2024

@AlexisDerumigny gentle bump :)

@mingzehuang
Copy link

Hi, @lrnv. I've finished the review, and the author has addressed my concerns. I recommend accepting this paper :)

@AlexisDerumigny
Copy link

AlexisDerumigny commented Aug 5, 2024

Review checklist for @AlexisDerumigny

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/mlysy/LocalCop?
  • License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@EFAcar) 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?

@AlexisDerumigny
Copy link

@AlexisDerumigny gentle bump :)

Thanks for the reminder @lrnv ! I am sorry for being so late, I had some personal problems. Now, the review is nearly completed up to two issues that I have opened.

@AlexisDerumigny
Copy link

Hi @lrnv, all my comments have been answered and I recommend the paper to be accepted.

@lrnv
Copy link

lrnv commented Sep 9, 2024

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@lrnv
Copy link

lrnv commented Sep 9, 2024

@editorialbot check references

@lrnv
Copy link

lrnv commented Sep 9, 2024

@editorialbot check repository

@lrnv
Copy link

lrnv commented Sep 20, 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.1201/9781315370279 is OK
- 10.18637/jss.v070.i05 is OK
- 10.1016/j.ecosta.2019.03.002 is OK
- 10.1111/j.1541-0420.2010.01472.x is OK
- 10.1214/13-EJS866 is OK
- 10.32614/CRAN.package.LocalCop is OK
- 10.32614/CRAN.package.copula is OK
- 10.18637/jss.v021.i04 is OK
- 10.18637/jss.v034.i09 is OK
- 10.18637/jss.v039.i09 is OK
- 10.32614/CRAN.package.VineCopula is OK
- 10.32614/CRAN.package.gamCopula is OK
- 10.32614/CRAN.package.CondCopulas is OK

🟡 SKIP DOIs

- None

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

⚠️ Error preparing paper acceptance. The generated XML metadata file is invalid.

No declaration for attribute displaystyle of element mfrac
No declaration for attribute displaystyle of element mfrac

@lrnv
Copy link

lrnv commented Sep 22, 2024

@EFAcar can you fix this?

@EFAcar
Copy link

EFAcar commented Sep 23, 2024

@lrnv based on this review the error code seems to be due to using displaymode with \dfrac. We now changed these to \frac. Hope this will fix the issue.

@lrnv
Copy link

lrnv commented Sep 23, 2024

@EFAcar ha yes it is true that you cant re-launch the process yourself. Let me check if it did it

@lrnv
Copy link

lrnv commented Sep 23, 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.1201/9781315370279 is OK
- 10.18637/jss.v070.i05 is OK
- 10.1016/j.ecosta.2019.03.002 is OK
- 10.1111/j.1541-0420.2010.01472.x is OK
- 10.1214/13-EJS866 is OK
- 10.32614/CRAN.package.LocalCop is OK
- 10.32614/CRAN.package.copula is OK
- 10.18637/jss.v021.i04 is OK
- 10.18637/jss.v034.i09 is OK
- 10.18637/jss.v039.i09 is OK
- 10.32614/CRAN.package.VineCopula is OK
- 10.32614/CRAN.package.gamCopula is OK
- 10.32614/CRAN.package.CondCopulas is OK

🟡 SKIP DOIs

- None

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

👋 @openjournals/dsais-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#5899, 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 23, 2024
@crvernon
Copy link

crvernon commented Sep 23, 2024

@editorialbot generate pdf

🔍 checking out the following:

  • reviewer checklists are completed or addressed
  • version set
  • archive set
  • archive names (including order) and title in archive matches those specified in the paper
  • archive uses the same license as the repo and is OSI approved as open source
  • archive DOI and version match or redirect to those set by editor in review thread
  • paper is error free - grammar and typos
  • paper is error free - test links in the paper and bib
  • paper is error free - refs preserve capitalization where necessary
  • paper is error free - no invalid refs without justification

@editorialbot
Copy link
Collaborator Author

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

@crvernon
Copy link

crvernon commented Sep 24, 2024

@EFAcar - this is looking good. I just need you to address the following minor items before I accept for publication:

  • LINE 85: "LocalCop:" is repeated in the reference
  • LINE 91: The "a" in "archimedean" should be capitalized. You can maintain capitalization in your references by using curly brackets around the characters you wish to maintain formatting for.

No need to conduct another release.

Let me know once these have been corrected and I will accept this for publication.

@EFAcar
Copy link

EFAcar commented Sep 24, 2024

@crvernon Thanks very much for catching these. They have now been fixed in this PR.

@crvernon
Copy link

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

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

@crvernon
Copy link

@editorialbot accept

@editorialbot
Copy link
Collaborator Author

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

@lrnv
Copy link

lrnv commented Sep 25, 2024

GG @EFAcar !!

@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: Acar
  given-names: Elif Fidan
  orcid: "https://orcid.org/0000-0003-2908-7691"
- family-names: Lysy
  given-names: Martin
  orcid: "https://orcid.org/0000-0001-9974-1121"
- family-names: Kuchinsky
  given-names: Alan
doi: 10.5281/zenodo.13801203
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Acar
    given-names: Elif Fidan
    orcid: "https://orcid.org/0000-0003-2908-7691"
  - family-names: Lysy
    given-names: Martin
    orcid: "https://orcid.org/0000-0001-9974-1121"
  - family-names: Kuchinsky
    given-names: Alan
  date-published: 2024-09-25
  doi: 10.21105/joss.06744
  issn: 2475-9066
  issue: 101
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 6744
  title: "LocalCop: An R package for local likelihood inference for
    conditional copulas"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.06744"
  volume: 9
title: "LocalCop: An R package for local likelihood inference for
  conditional copulas"

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.06744 joss-papers#5909
  2. Wait five minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.06744
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

@editorialbot editorialbot added accepted published Papers published in JOSS labels Sep 25, 2024
@crvernon
Copy link

🥳 Congratulations on your new publication @EFAcar! Many thanks to @lrnv for editing and @AlexisDerumigny and @mingzehuang for your time, hard work, and expertise!! JOSS wouldn't be able to function nor succeed without your efforts.

Please consider becoming a reviewer for JOSS if you are not already: https://reviewers.joss.theoj.org/join

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

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

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

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:

@EFAcar
Copy link

EFAcar commented Sep 25, 2024

@crvernon, @lrnv, @mingzehuang, @AlexisDerumigny thank you again for a very constructive review process!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted C++ published Papers published in JOSS R recommend-accept Papers recommended for acceptance in JOSS. review TeX Track: 5 (DSAIS) Data Science, Artificial Intelligence, and Machine Learning
Projects
None yet
Development

No branches or pull requests

6 participants