fix #17 fixed cache delete fxn and other caching fxns

fix #16 clear up usage of lsast_list, lsat_scenes and lsast_scene_files
fix #15 more details on what pkg is for
bump dev version

DESCRIPTION

@@ -5,8 +5,8 @@ Description: Get Landsat 8 Data from AWS public data sets
     (<https://aws.amazon.com/public-data-sets/landsat/>). Includes
     functions for listing images and fetching them, and handles
     caching to prevent unnecessary additional requests.
-Version: 0.0.6.9000
-Date: 2016-07-13
+Version: 0.0.9.9000
+Date: 2016-08-10
 Authors@R: c(person("Scott", "Chamberlain", role = c("aut", "cre"),
     email = "myrmecocystus@gmail.com"))
 License: MIT + file LICENSE
@@ -21,8 +21,10 @@ Imports:
     tibble,
     rappdirs
 Suggests:
+    roxygen2 (>= 5.0.1),
     testthat,
     knitr,
-    covr
+    covr,
+    raster
 VignetteBuilder: knitr
 RoxygenNote: 5.0.1

R/cache.R

@@ -12,6 +12,7 @@
 #' @details We cache using \code{\link[rappdirs]{user_cache_dir}}, find your cache
 #' folder by executing \code{rappdirs::user_cache_dir("landsat-pds")}
 #'
+#' @section Functions:
 #' \itemize{
 #'  \item \code{lsat_cache_list()} returns a character vector of full path file names
 #'  \item \code{lsat_cache_delete()} deletes one or more files, returns nothing

R/getlandsat-package.R

@@ -1,10 +1,35 @@
 #' getlandsat - get Landsat 8 data from AWS public data sets
 #'
+#' \pkg{getlandsat} provides access to Landsat \url{https://landsat.usgs.gov} 8
+#' metadata and images hosted on AWS S3 at
+#' \url{https://aws.amazon.com/public-data-sets/landsat}. The package only
+#' fetches data. It does not attempt to aid users in downstream usage.
+#'
 #' @importFrom readr read_csv
 #' @importFrom xml2 read_html read_xml xml_find_all as_list xml_children xml_name
 #' @importFrom httr content write_disk GET stop_for_status
 #' @name getlandsat-package
 #' @aliases getlandsat
 #' @docType package
 #' @keywords package
+#'
+#' @examples \dontrun{
+#' ## List scenes
+#' (res <- lsat_scenes(n_max = 10))
+#'
+#' ## List scene files
+#' lsat_scene_files(x = res$download_url[1])
+#'
+#' ## Get an image
+#' ### Returns path to the image
+#' lsat_image(x = "LC80101172015002LGN00_B5.TIF")
+#'
+#' ## Visualize
+#' if (requireNamespace("raster")) {
+#'   library("raster")
+#'   x <- lsat_cache_details()[[1]]
+#'   img <- raster(x$file)
+#'   plot(img)
+#' }
+#' }
 NULL

R/lsat_list.R

@@ -1,8 +1,4 @@
-#' @title List Landsat images
-#'
-#' @description This is an alternative to using lsat_scenes(). This
-#' function uses the AWS S3 API, while the other fxn simply downloads
-#' the up to date compressed csv file.
+#' List Landsat images
 #'
 #' @export
 #' @param max (integer) number indicating the maximum number of keys to return (max 1000,
@@ -15,6 +11,11 @@
 #' @param delimiter (character) string used to group keys. Read the AWS doc for
 #' more detail.
 #' @param ... curl args passed on to \code{\link[httr]{GET}}
+#'
+#' @details This is an alternative to using \code{\link{lsat_scenes}}. This
+#' function uses the AWS S3 API, while \code{\link{lsat_scenes}} downloads
+#' the up to date compressed csv file.
+#'
 #' @examples \dontrun{
 #' lsat_list(max = 10)
 #'

R/lsat_scenes.R

@@ -8,6 +8,12 @@
 #' file for \code{read_csv} for what parameter you can pass to modify it's
 #' behavior.
 #'
+#' This is an alternative to using \code{\link{lsat_list}}. This function
+#' downloads the up to date compressed csv file, while \code{\link{lsat_list}}
+#' uses the AWS S3 API.
+#'
+#' @seealso \code{\link{lsat_scene_files}}
+#'
 #' @examples \dontrun{
 #' res <- lsat_scenes()
 #' head(res)

R/lsat_scenes_files.R

@@ -2,7 +2,12 @@
 #'
 #' @export
 #' @param x (character) A URL to a scene html file
-#' @param ... Further args passed on to \code{\link[httr]{GET}}
+#' @param ... Curl options passed on to \code{\link[httr]{GET}}
+#'
+#' @details This function fetches files available in a scene, while
+#' \code{\link{lsat_scenes}} lists the scenes, but not their files
+#'
+#' @seealso \code{\link{lsat_scenes}}
 #'
 #' @return A data.frame with two columns:
 #' \itemize{

inst/vign/getlandsat_vignette.Rmd

@@ -17,8 +17,9 @@ knitr::opts_chunk$set(
 getlandsat introduction
 =======================
 
-Get Landsat 8 Data from AWS public data sets. Includes functions for 
-listing images and fetching them.
+`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. It does not attempt to aid users in downstream usage, but some additional functionality may be added.
+
+Potential users are probably anyone from scientists asking questions about biodiversity or land use change, to software developers creating tools for users to vizualize their data.
 
 ## Install