pyOpenSci / software-submission

Submit your package for review by pyOpenSci here! If you have questions please post them here: https://pyopensci.discourse.group/
94 stars 36 forks source link

Phenopype: a phenotyping pipeline for Python #24

Closed mluerig closed 3 years ago

mluerig commented 4 years ago

Submitting Author: Moritz Lürig (@mluerig)
All current maintainers: Moritz Lürig (@mluerig)
Package Name: phenopype One-Line Description of Package: a phenotyping pipeline for Python Repository Link: https://github.com/phenopype/phenopype Version submitted: 1.0.5 Editor: @jbencook
Reviewer 1: @agporto
Reviewer 2: @sdonoughe
Archive: DOI JOSS DOI: N/A Version accepted: 2.0.1
Date accepted (month/day/year): 05/13/2021

Edit: Bumped from 1.0.4 to 1.0.5 since submission.


Description

Phenopype is a high throughput phenotyping pipeline for Python to support biologists in extracting high dimensional phenotypic data from digital images. The program provides intuitive, high level computer vision functions for image preprocessing, segmentation, and feature extraction. Users can assemble their own function-stacks that can be stored in the human-readable yaml-format along with raw data and results, facilitating high throughput and full data reproducibility. Phenopype can be run from Python or from a Python Integrated Development Environment (IDE), like Spyder. Phenopype is designed to provide robust image analysis workflows that can be implemented with little or no Python experience.

Scope

* Please fill out a pre-submission inquiry before submitting a data visualization package. For more info, see this section of our guidebook.

Phenopype is designed to extract phenotypic data (https://en.wikipedia.org/wiki/Phenotype) of plants, animals, and other organisms from images and videos. By processing images in Python, through reproducible code and human readable configuration files, phenotyping becomes higher throughput and more reproducible than established GUI programs like "ImageJ".

Phenopype is intended for ecologists and evolutionary biologists that work with phenotypic data. Phenotypic data are an essential component of ecological and evolutionary research (https://www.nature.com/articles/nrg2897).

Only low level computer vision packages like OpenCV or scikit-image are out there that require a lot of configuring and a relatively deep understanding of computer vision and Python in general. Phenopype offers high level functions so that users can focus on the relevant analytic parts of image analysis.

Publication options

JOSS Checks - [ ] The package has an **obvious research application** according to JOSS's definition in their [submission requirements](https://joss.readthedocs.io/en/latest/submitting.html#submission-requirements). Be aware that completing the pyOpenSci review process **does not** guarantee acceptance to JOSS. Be sure to read their submission requirements (linked above) if you are interested in submitting to JOSS. - [ ] The package is not a "minor utility" as defined by JOSS's [submission requirements](https://joss.readthedocs.io/en/latest/submitting.html#submission-requirements): "Minor ‘utility’ packages, including ‘thin’ API clients, are not acceptable." pyOpenSci welcomes these packages under "Data Retrieval", but JOSS has slightly different criteria. - [ ] The package contains a `paper.md` matching [JOSS's requirements](https://joss.readthedocs.io/en/latest/submitting.html#what-should-my-paper-contain) with a high-level description in the package root or in `inst/`. - [ ] The package is deposited in a long-term repository with the DOI: *Note: Do not submit your package separately to JOSS*

Are you OK with Reviewers Submitting Issues and/or pull requests to your Repo Directly?

This option will allow reviewers to open smaller issues that can then be linked to PR's rather than submitting a more dense text based review. It will also allow you to demonstrate addressing the issue via PR links.

Code of conduct

P.S. Have feedback/comments about our review process? Leave a comment here

Editor and Review Templates

Editor and review templates can be found here

note: original repo url: https://github.com/mleurig/phenopype

mluerig commented 3 years ago

@lwasser: done, done and done! Thanks for wrapping this up so quickly. I will submit this to Methods in Ecology and Evolution in the next few days. Any suggestion for how I should bring up this review there? There are options for rOpenSci, but no pyOpenSci - should I just write this in the cover letter?

Feedback: I would not change anything in the review process; there were templates, instructions and at the start the roles were distributed clearly. My only suggestion for improvement is, as you may have guessed, to work with compulsory deadlines, and a stronger role of the editor to make sure they are kept. Otherwise it gets swept away by the flood of other work we all are involved with - at least I would prefer to have a deadline, simply to mark this in my agenda and get my butt going :-).

In any case, I am extremely grateful for the time you spent on reviewing and editing, and I thank everyone involved. pyOpenSci is a great consortium, and I would submit here again!

lwasser commented 3 years ago

wonderful. Thank you for this feedback.

And I hear you @mluerig i really do. I will note the need for deadlines and followup to ensure a more efficient process. Given I have your ear I have another question for you. Right now, you have citation information in your readme. I'm curious if you had thought about a more formal DOI / citation approach through a tool such as zenodo ?

I'm asking because i've been thinking a lot about citations. JOSS provides one by default through their review process. But Zenodo can track releases and provide a citable DOI as well. Do you have any thoughts on this by chance?

i will merge both pr's shortly to our website. Thank you for doing that so quickly!

https://github.com/pyOpenSci/pyopensci.github.io/pull/62/files https://github.com/pyOpenSci/pyopensci.github.io/pull/63

mluerig commented 3 years ago

the need for deadlines and followup

this can really just be a short post in the pyOpenSci issue to remind everyone

@lwasser good point about citations. phenopype both has a zenodo DOI and a bioRxiv DOI - would it make sense to provide the zenodo reference in the manuscript, and then place the manuscript reference in the readme?

I will submit this to Methods in Ecology and Evolution in the next few days. Any suggestion for how I should bring up this review there? There are options for rOpenSci, but no pyOpenSci - should I just write this in the cover letter?

do you have any thoughts on this?

lwasser commented 3 years ago

hi @mluerig my apologies i was out of the office Friday.

I think for now it does make sense to include the zenodo reference in the manuscript. And then absolutely include the manuscript reference once you have it. If the article is really methods based (i presume it is given the journal you are submitting to) then i would think once you have a final journal DOI, that citation will be preferred over zenodo.

Yes, rOpenSci has a relationship with them. I have yet to build that relationship but can and would like to once we really get moving on the project in August. I need to speak with Karthik more about how that relationship works to better understand it. Yes please add this to your cover letter. And if there is a person that I can reach out to there, please feel free to forward their information to me OR give them my contact information. How does that sound?

mluerig commented 3 years ago

yupp that sounds good - I proceeded with these suggestions!

lwasser commented 3 years ago

Perfect!

Sent from my Verizon, Samsung Galaxy smartphone Get Outlook for Androidhttps://aka.ms/AAb9ysg


From: Moritz Lürig @.> Sent: Tuesday, May 18, 2021 1:14:27 AM To: pyOpenSci/software-review @.> Cc: Leah Wasser Leah.Wasser@Colorado.EDU; State change @.***> Subject: Re: [pyOpenSci/software-review] Phenopype: a phenotyping pipeline for Python (#24)

yupp that sounds good - I proceeded with these suggestions!

— You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHubhttps://github.com/pyOpenSci/software-review/issues/24#issuecomment-842917389, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AB2LPKV3BZE3O34B2I6HFLLTOIHVHANCNFSM4MY5HIMQ.

lwasser commented 2 years ago

hey 👋 @mluerig @jbencook @agporto @sdonoughe ! I hope that you are all well. I am reaching out here to all reviewers and maintainers about pyOpenSci now that i am working full time on the project (read more here). We have a survey that we'd like for you to fill out so we can:

🔗 HERE IS THE SURVEY LINK 🔗

  1. invite you to our slack channel to participate in our community (if you wish to join - no worries if that is not how you prefer to communicate / participate).
  2. Collect information from you about how we can improve our review process and also better serve maintainers. The survey should take about 10 minutes to complete depending upon how much you decide to write. This information will help us greatly as we make decisions about how pyOpenSci grows and serves the community. Thank you so much in advance for filling it out.

NOTE: this is different from the form designed for reviewers to sign up to review. If there are other maintainers for this project, please ping them here and ask them to fill out the survey as well. It is important that we ensure packages are supported long term or sunsetted with sufficient communication to users. Thus we will check in with maintainers annually about maintenance.

Thank you in advance for doing this and supporting pyOpenSci.

lwasser commented 2 years ago

hey there @mluerig @jbencook @agporto 👋 Just a friendly reminder to take 5-10 minutes to fill out our survey . We really appreciate it. Thank you in advance for helping us by filling out the survey!! 🙌 Moritz, it's really important for us to collect information from our maintainers so that we can both stay in touch with you regarding package maintenance and also support you through time. We really appreciate your time in filling this out. Also are you the sole maintainer of this package? if not, please have your co-maintainers also fill it out and please list them here as well. Many thanks in advance!

✨ Seth thank you so much for taking the time to fill it out 🙌

🔗 HERE IS THE SURVEY LINK 🔗

mluerig commented 2 years ago

Done! 😊

From: Leah Wasser @.> Sent: Wednesday, 28 September 2022 17:29 To: pyOpenSci/software-review @.> Cc: Moritz Lürig @.>; Mention @.> Subject: Re: [pyOpenSci/software-review] Phenopype: a phenotyping pipeline for Python (#24)

hey there @mluerig https://github.com/mluerig @jbencook https://github.com/jbencook @agporto https://github.com/agporto 👋 Just a friendly reminder to take 5-10 minutes to fill out our survey . We really appreciate it. Thank you in advance for helping us by filling out the survey!! 🙌 Moritz, it's really important for us to collect information from our maintainers so that we can both stay in touch with you regarding package maintenance and also support you through time. We really appreciate your time in filling this out. Also are you the sole maintainer of this package? if not, please have your co-maintainers also fill it out and please list them here as well. Many thanks in advance!

✨ Seth thank you so much for taking the time to fill it out 🙌

https://forms.gle/ZZXcD1hr18tYmY2p6 🔗 HERE IS THE SURVEY LINK 🔗

— Reply to this email directly, view it on GitHub https://github.com/pyOpenSci/software-review/issues/24#issuecomment-1261083756 , or unsubscribe https://github.com/notifications/unsubscribe-auth/ADXMKRCCGS7R4KRTU2FOPJDWARP2TANCNFSM4MY5HIMQ . You are receiving this because you were mentioned. https://github.com/notifications/beacon/ADXMKRHVKZGAT6SZCDFU4JDWARP2TA5CNFSM4MY5HIM2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOJMVJY3A.gif Message ID: @. @.> >

lwasser commented 1 year ago

hey there @mluerig i've going through and updating our package catalog and noticed that there is no pyopensci badge on your readme for phenopype! this only came up because the original url here was updated to phenopype/phenopype so i had to search for ya!

i wondered if you were open to adding the reviewed badge to your project readme? Many thanks!

[![pyOpenSci](https://tinyurl.com/y22nb8up)](https://github.com/pyOpenSci/software-review/issues/24)
mluerig commented 1 year ago

Hi Leah – will take care of it as soon as I’m back from vacation!

Cheers Moritz

From: Leah Wasser @.> Sent: Monday, 6 March 2023 23:09 To: pyOpenSci/software-submission @.> Cc: Moritz Lürig @.>; Mention @.> Subject: Re: [pyOpenSci/software-submission] Phenopype: a phenotyping pipeline for Python (#24)

hey there @mluerig https://github.com/mluerig i've going through and updating our package catalog and noticed that there is no pyopensci badge on your readme for phenopype! this only came up because the original url here was updated to phenopype/phenopype so i had to search for ya!

i wondered if you were open to adding the reviewed badge to your project readme? Many thanks!

[pyOpenSci](https://github.com/pyOpenSci/software-review/issues/24 https://tinyurl.com/y22nb8up)%5d(https:/github.com/pyOpenSci/software-review/issues/24 )

— Reply to this email directly, view it on GitHub https://github.com/pyOpenSci/software-submission/issues/24#issuecomment-1457083223 , or unsubscribe https://github.com/notifications/unsubscribe-auth/ADXMKRDPREJ4HB2X5XQRUETW2ZN65ANCNFSM4MY5HIMQ . You are receiving this because you were mentioned. https://github.com/notifications/beacon/ADXMKRFD7XPD5U4YQAZWYQ3W2ZN65A5CNFSM4MY5HIM2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOK3MVGVY.gif Message ID: @. @.> >

lwasser commented 1 year ago

Thank you! Enjoy your vacation!!!

NickleDave commented 1 year ago

Hi @mluerig just checking back as we're updating metadata for our pyOpenSci sprint at PyCon -- are you back from vacation and if so could you add our badge when you get a chance?

https://github.com/pyOpenSci/software-submission/issues/24#issuecomment-1457083223

We're happy to make a PR to phenophype adding it to the README if that would help!

mluerig commented 1 year ago

finally done!

NickleDave commented 1 year ago

Great, thanks so much @mluerig!