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
getlandsat package #58
Comments
Editor checks:
Editor commentsTwo things from initial check, not enough to hold up review:
Reviewers: @andeek |
Please check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide
DocumentationThe package includes all the following forms of documentation:
Functionality
Estimated hours spent reviewing: 4.5 Review CommentsThis package is very well done. I especially liked the caching functionality as the images can be somewhat large and slow to download. The functionality seems very self explanatory except for one thing. I am unsure of when to use DocumentationA statement of need This is partially true, there is a clear statement in the README of what the package does, but not who the target audience is. Perhaps the section from the summary in the review issue could be added to the README as a more thorough explanation of the package goals and audience. Installation instructions: Installation instructions in the README worked perfectly and were very clear. Vignette(s) The vignette ran successfully and does demonstrate the major functionality in the paper. It might be helpful to talk a little bit in the vignette about what the Function Documentation: All exported functions are well documented in help. Easy to read and understand. Examples I ran into a problem with the following example: lsat_cache_delete(files = lsat_cache_list()[1]) within the function, there is the following line that duplicates a portion of the path. files <- file.path(lsat_path(), "L8", dat$wrs_path, dat$wrs_row,
dat$str, files)
Error: These files don't exist or can't be found:
/Users/andeek/Library/Caches/landsat-pds/L8/001/003/LC80010032014272LGN00/L8/001/003/LC80010032014272LGN00/LC80010032014272LGN00_B1.TIF.ovr Other than that, all examples work as expected. Community guidelines I found a contributor code of conduct, but not a guide for how to contribute. The DESCRIPTION file is complete with FunctionalityInstallation: No problems with installation. Functionality: See the comment on examples for issue with There were no unit tests for the caching functions, but I'm not sure if that's because it's specific to the user's machine so would be harder to write? All the other functions are tested extensively and pass on my machine. Packaging guidelines
|
Thanks very much @andeek - I'll get to this asap |
will rbuildignore that ropensci-archive/getlandsat#13
i think i stopped doing it cause it was failing for some weird reason, will get it back started
thanks!
Thanks, i'll clarify ropensci-archive/getlandsat#14
thanks, will do ropensci-archive/getlandsat#15
okay, will do ropensci-archive/getlandsat#16
I'll fix that and write a test for it, thanks ropensci-archive/getlandsat#17
will add a
i think I avoided that as they would take a while to run, but i'll try to add some ropensci-archive/getlandsat#19
thanks for noting, will add
thanks for noting, will add |
@noamross anything else to do? |
thanks again @andeek for the review @noamross |
Final checks all pass. Approved! @sckott you know the drill from here. |
Summary
getlandsat
provides access to Landsat (https://landsat.usgs.gov/) 8 metadata and images hosted on AWS S3 at https://aws.amazon.com/public-data-sets/landsat/ The package only fetches data for users, and does not aid in downstream usage, but additional functionality may be added if deemed necessary.https://github.com/ropenscilabs/getlandsat
Anyone that wants to use Landsat images - ecologists, map makers, etc.
None that I know of
Requirements
Confirm each of the following by checking the box. This package:
Publication options
paper.md
with a high-level description.Detail
R CMD check
(ordevtools::check()
) succeed? Paste and describe any errors or warnings:The text was updated successfully, but these errors were encountered: