Skip to content

[REVIEW]: MorphoMetriX: a photogrammetric measurement GUI for morphometric analysis of megafauna #1825

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
38 tasks done
whedon opened this issue Oct 21, 2019 · 82 comments
Closed
38 tasks done
Assignees
Labels
accepted published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review

Comments

@whedon
Copy link

whedon commented Oct 21, 2019

Submitting author: @wingtorres (Walter Torres)
Repository: https://github.com/wingtorres/morphometrix
Version: v1.0.2
Editor: @Kevin-Mattheus-Moerman
Reviewer: @isaacvandor, @bw4sz
Archive: 10.5281/zenodo.3606865

Status

status

Status badge code:

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

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

@isaacvandor & @bw4sz, 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 @Kevin-Mattheus-Moerman know.

Please try and complete your review in the next two weeks

Review checklist for @isaacvandor

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 (@wingtorres) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

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: 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 @bw4sz

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 (@wingtorres) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

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

whedon commented Oct 21, 2019

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @isaacvandor, @bw4sz it looks like you're currently assigned to review this paper 🎉.

⭐ 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 Oct 21, 2019

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Oct 21, 2019

@isaacvandor
Copy link

isaacvandor commented Oct 22, 2019

@Kevin-Mattheus-Moerman I've completed my review and there doesn't seem to be anything impeding acceptance. I did open an issue in the target repo with a feature enhancement I think could help, but that certainly shouldn't stop the rest of the review process.

Updating with link to issue filed in target repo: Issue #1: Allow user to change size of width lines/dots

@Kevin-Mattheus-Moerman
Copy link
Member

@isaacvandor thanks. Can you mention/link to that issue here so we have a record of it? Thanks a lot for your help!

@Kevin-Mattheus-Moerman
Copy link
Member

@bw4sz this is where the review takes place. The check boxes at the top guide you through the process. Let me know if you have questions.

@bw4sz
Copy link

bw4sz commented Oct 22, 2019

@patrickcgray throw me some sample whale images to play with here?

@bw4sz
Copy link

bw4sz commented Oct 22, 2019

grabbing and testing with some data from https://github.com/patrickcgray/cetacean_photogram

@bw4sz
Copy link

bw4sz commented Oct 22, 2019

testing with this image looks good.
DSC00917

@bw4sz
Copy link

bw4sz commented Oct 22, 2019

added a small idea wingtorres/morphometrix#2

@kthyng
Copy link

kthyng commented Oct 22, 2019

What a cool picture to get in my email from github notifications!

@patrickcgray
Copy link

patrickcgray commented Oct 25, 2019 via email

@Kevin-Mattheus-Moerman
Copy link
Member

@wingtorres can you work on adding community guidelines?

Here is some more information on this:
https://help.github.com/en/github/site-policy/github-community-guidelines

Also here is a link to one of my projects. There I link to contributing guidelines in a CONTRIBUTING.md file in the README.md, which is an approach I recommend.
https://github.com/gibbonCode/GIBBON

If you imagine your contributors community will grow I also recommend adding a CODE_OF_CONDUCT.mdfile too (e.g. based on this template: https://www.contributor-covenant.org/).

@Kevin-Mattheus-Moerman
Copy link
Member

@wingtorres can you work on the issues raised by the reviewers? https://github.com/wingtorres/morphometrix/issues

@wingtorres
Copy link

@Kevin-Mattheus-Moerman Sorry to be out of touch! I've been a bit swamped recently, but I have some time blocked out end of next week to incorporate the reviewers suggestions and add the community guidelines. Thanks!

@danielskatz
Copy link

👋 @wingtorres - Have you made progress on this?

@wingtorres
Copy link

@danielskatz Yes finally! I have updated the code to address @bw4sz 's suggestion and in regards to @isaacvandor 's thoughts I have at least pointed to where users can customize their version of the code in lieu of adding a preferences menu to modify the GUI cosmetics (although we may want to do this down the line, I believe the code will be useful to people without it for now). @Kevin-Mattheus-Moerman thank you for your suggestion to include the contribute and code of conduct files - I have added those as well. Thanks y'all! Let me know what else needs to be done.

@wingtorres
Copy link

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Dec 15, 2019

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Dec 15, 2019

@Kevin-Mattheus-Moerman
Copy link
Member

@isaacvandor, @bw4sz are you happy with the changes implemented? I see all boxes are ticked. Are you happy to recommend acceptance for this work? Thanks!

@Kevin-Mattheus-Moerman
Copy link
Member

@wingtorres thanks for adding community guidelines. One note on your CONTRIBUTING.md file (https://github.com/wingtorres/morphometrix/blob/master/CONTRIBUTING.md). It appears it was copied from my own project's file I referred to. Please review the variable naming section since I changed that to suit my project (MATLAB syntax for mesh data handling). Perhaps yours should instead refer to some Python coding style (perhaps check what other major Python projects use there).

@wingtorres
Copy link

You are totally right that's embarrassing :D, sorry I should have paid closer attention. I'm a bit new to Python, but I try to adhere to the PEP-008 standards so I'll post a link to that.

@Kevin-Mattheus-Moerman
Copy link
Member

@isaacvandor, @bw4sz are you happy with the changes implemented? I see all boxes are ticked. Are you happy to recommend acceptance for this work? Thanks!

@isaacvandor, @bw4sz ☝️ Thanks again for your help!

@Kevin-Mattheus-Moerman
Copy link
Member

@whedon generate pdf

@wingtorres
Copy link

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Jan 15, 2020

@wingtorres
Copy link

@whedon check references

@whedon
Copy link
Author

whedon commented Jan 15, 2020

Reference check summary:

OK DOIs

- 10.1007/BF00233083 is OK
- 10.1038/s41559-018-0534-2 is OK
- 10.1371/journal.pone.0017686 is OK
- 10.1139/z85-345 is OK
- 10.1111/1365-2435.12200 is OK
- 10.3354/meps12522 is OK
- 10.1139/z98-195 is OK
- 10.3354/meps09675 is OK
- 10.1146/annurev-marine-010318-095323 is OK
- 10.3389/fmars.2017.00366 is OK
- 10.1139/cjz-2014-0311 is OK
- 10.1002/ajp.1350300207 is OK
- 10.1111/j.1748-7692.2009.00288.x is OK
- 10.1111/mms.12527 is OK
- 10.1038/nmeth.2089 is OK
- 10.1126/science.290.5497.1695b is OK
- 10.1002/ecs2.1468 is OK
- 10.1139/juvs-2015-0020 is OK

MISSING DOIs

- https://doi.org/10.2307/1374074 may be missing for title: Southern Blue and Fin Whales

INVALID DOIs

- 10.1641/0006-3568(2003)053[0210:WAS]2.0.CO;2 is INVALID

@wingtorres
Copy link

wingtorres commented Jan 15, 2020

The missing DOI is for a paper that was published in 1929 so it does not have one as far as we can tell. I'm not sure what to do about the invalid DOI though...it should link to the article below. https://academic.oup.com/bioscience/article/53/3/210/251944

@arfon
Copy link
Member

arfon commented Jan 15, 2020

I'm not sure what to do about the invalid DOI though...it should link to the article below. https://academic.oup.com/bioscience/article/53/3/210/251944

I think you can ignore this. The URL library we're using for Whedon doesn't like https://doi.org/10.1641/0006-3568(2003)053[0210:WAS]2.0.CO;2 (it's a pretty unusual URL) but it looks like it resolves.

@whedon
Copy link
Author

whedon commented Jan 15, 2020

Reference check summary:

OK DOIs

- 10.1007/BF00233083 is OK
- 10.1038/s41559-018-0534-2 is OK
- 10.1371/journal.pone.0017686 is OK
- 10.1139/z85-345 is OK
- 10.1111/1365-2435.12200 is OK
- 10.3354/meps12522 is OK
- 10.1139/z98-195 is OK
- 10.3354/meps09675 is OK
- 10.1146/annurev-marine-010318-095323 is OK
- 10.3389/fmars.2017.00366 is OK
- 10.1139/cjz-2014-0311 is OK
- 10.1002/ajp.1350300207 is OK
- 10.1111/j.1748-7692.2009.00288.x is OK
- 10.1111/mms.12527 is OK
- 10.1038/nmeth.2089 is OK
- 10.1126/science.290.5497.1695b is OK
- 10.1002/ecs2.1468 is OK
- 10.1139/juvs-2015-0020 is OK

MISSING DOIs

- https://doi.org/10.2307/1374074 may be missing for title: Southern Blue and Fin Whales

INVALID DOIs

- 10.1641/0006-3568(2003)053[0210:WAS]2.0.CO;2 is INVALID

@kyleniemeyer
Copy link

Hi @wingtorres, looks like the references are fine, but I have just a few typographic issues to resolve:

  • Can you remove the period at the end of the title?
  • in a number of places, you are missing commas after "i.e." and "e.g."
  • in the 4th paragraph, there are some inconsistencies in some citation formatting; you can use these syntax options for in-text citations:
- `@author:2001`  ->  "Author et al. (2001)"
- `[@author:2001]` -> "(Author et al., 2001)"
- `[@author1:2001; @author2:2001]` -> "(Author1 et al., 2001; Author2 et al., 2002)"

Otherwise, it is well written, thanks!

@wingtorres
Copy link

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Jan 15, 2020

@wingtorres
Copy link

@kyleniemeyer thank you for the typographic edits! Just made the changes you suggested and generated a new proof.

@kyleniemeyer
Copy link

@whedon accept

@whedon
Copy link
Author

whedon commented Jan 16, 2020

Attempting dry run of processing paper acceptance...

@whedon
Copy link
Author

whedon commented Jan 16, 2020

Reference check summary:

OK DOIs

- 10.1007/BF00233083 is OK
- 10.1038/s41559-018-0534-2 is OK
- 10.1371/journal.pone.0017686 is OK
- 10.1139/z85-345 is OK
- 10.1111/1365-2435.12200 is OK
- 10.3354/meps12522 is OK
- 10.1139/z98-195 is OK
- 10.3354/meps09675 is OK
- 10.1146/annurev-marine-010318-095323 is OK
- 10.3389/fmars.2017.00366 is OK
- 10.1139/cjz-2014-0311 is OK
- 10.1002/ajp.1350300207 is OK
- 10.1111/j.1748-7692.2009.00288.x is OK
- 10.1111/mms.12527 is OK
- 10.1038/nmeth.2089 is OK
- 10.1126/science.290.5497.1695b is OK
- 10.1002/ecs2.1468 is OK
- 10.1139/juvs-2015-0020 is OK

MISSING DOIs

- https://doi.org/10.2307/1374074 may be missing for title: Southern Blue and Fin Whales

INVALID DOIs

- 10.1641/0006-3568(2003)053[0210:WAS]2.0.CO;2 is INVALID

@whedon
Copy link
Author

whedon commented Jan 16, 2020

Check final proof 👉 openjournals/joss-papers#1222

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

@whedon accept deposit=true

@kyleniemeyer
Copy link

@whedon accept deposit=true

@whedon
Copy link
Author

whedon commented Jan 16, 2020

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

@whedon
Copy link
Author

whedon commented Jan 16, 2020

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

@whedon
Copy link
Author

whedon commented Jan 16, 2020

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

@kyleniemeyer
Copy link

Congrats on your article's publication in JOSS @wingtorres!

Many thanks to @isaacvandor and @bw4sz for reviewing this submission, and @Kevin-Mattheus-Moerman for editing.

@whedon
Copy link
Author

whedon commented Jan 16, 2020

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

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

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

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:

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

No branches or pull requests

10 participants