-
-
Notifications
You must be signed in to change notification settings - Fork 104
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
Submission: MODIStsp #184
Comments
hey @lbusett one of my students used this package in his final project in the fall! he showed it to me and said it was really nice. |
I have also reached out to @jeffreyhanson by email. |
sure @karthik i'll review this. i wanted to spend some time playing with it after my student showed it to me. What is the deadline? i'll need a few weeks given i just got back from travel today. |
Sure, I'm happy to review this. I'm pretty busy at the moment though, so it might be a few weeks before I can get around to it if that's ok? |
Editor checks:
Editor commentsWork in progress (dealing with installation issues) Reviewers: @lwasser and @jeffreyhanson |
@lwasser @jeffreyhanson Thanks very much! I've tentatively assigned Feb 10th. Please let me know if anything changes. 🙏 |
@karthik Sorry to hear that you having problems in installation.... 😟 Unfortunately, as I reported in the submission, that is a common problem related to the requirements of the Let me know if I can help in any way! |
Hi @karthik . Just wanted to ask if in the end you managed to solve the installation issues or you are still having problems. In case you are working on a mac and you are still struggling, these are the "latest" instructions I found regarding how to install packages "RGtk2" (and consequently gWidgetsRGtk2) on mac os Sierra: |
Awesome work @lbusett! This package looks absolutely amazing. I've just started working on my review, but I thought I would let you know that some of the unit tests fail on my system in case you wanted to address this before I submit my review. I've included the output below and a copy of my session info.
Session information
Let me know if there's any other info I can provide. |
See (ropensci/software-review#184 (comment)) - FIx bug related to new xml version - Fix bug related to changes in metadata retreived from lpdaac - bumps required xml2 version to 1.2.0
Thanks! Glad you like our package! Concerning the tests, thanks for reporting the issues. They should now be fixed. One was due to a recent change in |
hey @lbusett or @jeffreyhanson i'm a bit confused on the quartz install i'm here: next, edit the configure options for GTK to require x11 rather than Quartz:
in the def install section, remove the reference to quartz and switch to:
And would like to understand what part of the gtk+ file i need to edit. do i just replace
it's taking me some time to get everything installed and this step is a bit confusing. thank you for any advice! So i'm not sure if i did this right but another question. Does this message make sense:
|
hi @lwasser , sorry you are having trouble... unfortunately, at the moent RGtk2 installation on mac is troublesome (and the solution to the trouble seems to change with time.. ;-(.
and then proceed with Concerning the "R session is headless; GTK+ not initialized." : this does not bode well. It (should) mean that RGtk2 does not find a "graphical environment" to use. I fear that if you try to load Again, sorry for the trouble. I hope you'll be able to solve it easily (this link may also help : https://gist.github.com/sebkopf/9405675). Otherwise, I'll try to get my hands on a (modern) mac pc and see if I manage to provide better instructions. |
ok so remove
does this help at all with troubleshooting? if i say "n" to install from source it just quits. i'm wondering if i get this error because i edited the install code above incorrectly (i left disable-visibility in the code). |
Just a check: did you already do
which I think is setting the path to gtk+ and should solve to cairo installation issue (ERROR: gtk+2.0 not found by pkg-config.)? |
ok!! i think i just got it. THANK YOU @lbusett i just installed those packages manually but also i hadn't run that line above that you suggested so i did that too. phew! i'll play with the package more tomorrow. thank you for the help. |
Sorry for the late reply @lbusett, I just installed the latest GitHub version and all the tests pass now. Thank for you fixing this so quickly. |
Good. In the end, both problems were due to a breaking change in xml2. Since the cran version uses xml, I was not notified about it. By the way: a user signalled us a bug in the gui that I probably introduced while refactoring the code for ropensci submission. I am going to commit a fix for it ASAP. |
@karthik Ok, thanks for the update! |
@jeffreyhanson Quick ping/reminder to sign off or ask more questions for @lbusett 🙏 |
I'm sorry for the late reply, this completely fell off my radar. @lbusett has done an amazing job and addressed all my issues/suggestions. |
@jeffreyhanson @lwasser Thanks! Glad you liked the improvements! I think the review process allowed to really improve the package! @karthik How should we proceed from here? Consider that unfortunately i will be forced to make some changes with respect to the reviewed package due to some very revcent changes in NASA policies (e.g., discontinued support for FTP download, and discontinuation of most of version 005 products). I expect to be able to release a new version by the beginning of next week. |
@lbusett 👋 I'm glad to see @jeffreyhanson and @lwasser have signed off. I suggest making those changes and pushing a new release before we proceed with acceptance. I'm painfully aware of such policy changes. |
I finally managed to put out a new version (1.3.4), including changes required to address changes in NASA policies. The new version is available on github, and I plan to upload it to CRAN soon. I'd like therefore to ask:
Lorenzo |
@karthik, @jeffreyhanson, @lwasser Hi all, please note that MODIStsp v 1.3.4 is now on cran. Please let me know what would be the next steps to be done for final approval on ropensci. Thanks in advance! Lorenzo |
Hi, just a quick ping for @karthik, since I saw you are back to work: How can we further proceed on this? Lorenzo |
Hi @karthik Sorry for bringing this up again, but it seems this submission got stuck in some kind of limbo, recently, and i would like to close this task. Could we have any updates regarding next steps? |
Sorry about the delay, i'll ping Karthik |
@lbusett Apologies for the delay -- will follow up in a few. |
@lbusett Sincere apologies for the delay. Your last notification came during my holiday and got lost in a giant pile of unread GitHub notifications 😢But now that I see all the Is have been dotted and T's crossed, we are ready to go. Congrats @lbusett, your submission has been approved! 🎉 Thank you for submitting and @lwasser and @jeffreyhanson for thorough and timely reviews. To-dos:
Welcome aboard! We'd also love a blog post about your package, either a short-form intro to it (https://ropensci.org/technotes/) or long-form post with more narrative about its development. ((https://ropensci.org/blog/). If you are, @stefaniebutland will be in touch about content and timing. |
@lbusett You can also now add the status badge (I should have alerted you earlier) to your README. It should switch to accepted shortly:
|
thanks! No worries about the delay: I know it happens. I will do those last steps ASAP. Thanks again for your very usefeul reviews: I think they allowed me to really improve the package! Lorenzo |
Hello @lbusett. Glad to hear you're interested in contributing a technote. It might get even more eyes on your work. Examples of technotes are here: https://ropensci.org/technotes/ We ask that you submit your draft post via pull request a week before the planned publication date so we can give you some feedback. Happy to answer any questions. |
Hi @karthik , I just transferred the repo to https://github.com/ropensci/MODIStsp after making the necessary changes. (Note that the build on Travis is currently failing apparently due to a downtime of the NSIDC server) |
@lbusett happy to be included as a reviewer in the description. thank you for your effort on this awesome package!! it's a great community contribution. i'm also happy to see it being embraced within the ropensci community!! yay! |
@lwasser Thanks! I will add you in the description ASAP! |
I am currently unable to modify the package settings (i.e., to modify the link to the website at the top of the repo page). Could you grant me admin settings on the repository ? Lorenzo |
Great package! I have just 1 question, while running the package I saw written that QA's were computed. In my PC several folders were created. In which folder the 'corrected' images of MODIS are? Or should I make something else (e.g. use another package) in order to take the good quality images? |
@vanto1994 Please post this question in the project's repo (https://github.com/ropensci/MODIStsp/issues), not this review thread. Thanks! |
@vanto1994 I took the liberty of moving the issue in the proper issues page. I will reply you there. |
Summary
Facilitates the creation of time series of raster images derived from MODIS Satellite Land Products by automating and standardizing several preprocessing steps (e.g., download, mosaicing, reprojection, resize, indexes computation, data extraction). Processing parameters are set using a powerful GUI. Non-interactive execution using saved Options Files allows updating time series when new images are available using cron jobs.
URL for the package (the development repository, not a stylized html page):
https://github.com/lbusett/MODIStsp
Please indicate which category or categories from our package fit policies this package falls under *and why(? (e.g., data retrieval, reproducibility. If you are unsure, we suggest you make a pre-submission inquiry.):
Who is the target audience and what are scientific applications of this package?
The target audience includes anyone involved/interested in monitoring the properties of the Earth surface through the analysis of time series of coarse resolution satellite imagery.
MODIS satellite data are in fact used in many different scientific applications, since they allow global daily monitoring of the earth surface. Their applications are therefore too many to analyze in this context. Among the main ones, I can cite (borrowing a bit from wikipedia...) the monitoring of vegetation health by means of time-series analyses with vegetation indices, the analysis of long term land cover changes (e.g. to monitor deforestation rates), real time monitoring of snow/ice cover, analysis of water quality and of impacts of floodings, change of water levels of major lakes and the detection and mapping of wildland fires. MODIS data are also extensively used as ancillary input in modelling applications (e.g., biogeochemical models for Primary Production modelling; crop yield models). Additionally, MODIS data are often used by biologists/zoologists as ancillary data to monitor/model migratory patterns.
(Introductory material concerning MODIS and its main applications can be found for example here and here)
Are there other R packages that accomplish the same thing? If so, how does
yours differ or meet our criteria for best-in-category?
The main “R” packages overlapping MODIStsp functionality are
MODIS
andMODISTools
MODIStsp and MODIS have substantial overlaps, since they are both meant to provide access and preprocessing to MODIS products. Two aspects that in my opinion differentiate MODIStsp are its user-friendliness (I think that the MODIStsp Graphical User Interface is very helpful, in particular for less skilled "R" users, though I am clearly a bit biased on the topic), and its ability to allow on-the-fly creation of time series of standard/user provided Spectral Indexes (often used for time series analysis) and of MODIS quality indicators. On the other hand, MODIS provides some additional post-processing functionality (e.g., filtering/smoothing), which is something I'm planning to add in the near future.
MODIStools is a very nice package, but it provides somewhat more limited functionality. It is based on the ORNL DAAC webservice (https://modis.ornl.gov/data/modis_webservice.html), and therefore provides access only to some MODIS products. Additionally, it is meant to allow access to data concerning a given set of points and their surroundings, while both MODIStsp and MODIS are meant to provide downloading capabilitites to the "full" MODIS raster data (or subsets of those, although the full HDFs need always to be downloaded).
The ModisDownload function of package rts is also overlapping, but its functionalities are more limited than either MODIStsp and MODIS. (Actually, an early version of ModisDownload is what got us started in developing the package - proper acknwoledgement is given in MODIStsp documentation).
Other packages providing access to MODIS data include MODISSnow (limited to snow cover products distributed by NSIDC) and modiscloud (which provides tools for processing Level 2 Cloud Mask SWATH products – not supported by MODIStsp)
For further reference, our paper concerning MODIStsp published on CAGEO provides in Section 1 a short comparison of the different tools currently available for accessing MODIS data (both "R" based or not).
If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted.
pre-submission inquiry for MODIStsp #143
Requirements
Confirm each of the following by checking the box. This package:
does not violate the Terms of Service of any service it interacts with.
has a CRAN and OSI accepted license.
contains a README with instructions for installing the development version.
NOTE ON INSTALLATION Installation (both from github or from CRAN) may be a bit problematic due the fact that MODIStsp requires the gWidgetsRGtk2 library to build its GUI, which often have installation problems on Windows and Mac due to requiring the GTK+ library, and needing several packages to be installed beforehand on Linux. In case of problems, it is better to install gWidgetsRGtk2 beforehand. Specific instructions are provided at (http://lbusett.github.io/MODIStsp/articles/installation.html)
includes documentation with examples for all functions.
contains a vignette with examples of its essential functions and uses.
has a test suite.
has continuous integration, including reporting of test coverage, using services such as Travis CI, Coveralls and/or CodeCov.
I agree to abide by ROpenSci's Code of Conduct during the review process and in maintaining my package should it be accepted.
Publication options
Do you intend for this package to go on CRAN?
The package is already on CRAN (https://cran.r-project.org/package=MODIStsp)
Do you wish to automatically submit to the Journal of Open Source Software? If so:
paper.md
matching JOSS's requirements with a high-level description in the package root or ininst/
.Do you wish to submit an Applications Article about your package to Methods in Ecology and Evolution? If so:
Detail
Does
R CMD check
(ordevtools::check()
) succeed? Paste and describe any errors or warnings:Does the package conform to rOpenSci packaging guidelines? Please describe any exceptions:
If this is a resubmission following rejection, please explain the change in circumstances:
If possible, please provide recommendations of reviewers - those with experience with similar packages and/or likely users of your package - and their GitHub user names:
Michael Sumner - @mdsumner
Jeff Hanson - @jeffreyhanson
Leah Wasser - @lwasser
Robin Lovelace - @robin
The text was updated successfully, but these errors were encountered: