Improve docs and organization

Author: twedl

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: canmap
-Title: Standard Canadian geography shapefiles.
+Title: Standard Canadian geography shapefiles
 Version: 0.0.0.9000
 Authors@R: 
     person(given = "Jesse",
@@ -11,6 +11,7 @@ Description: What the package does (one paragraph).
 License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
+Depends: R (>= 3.4)
 Imports: 
     here,
     fs,
@@ -23,5 +24,6 @@ RoxygenNote: 7.0.2
 Suggests: 
     knitr,
     rmarkdown,
-    sf
+    sf,
+    testthat (>= 2.1.0)
 VignetteBuilder: knitr

NAMESPACE

@@ -4,3 +4,4 @@ export("%>%")
 export(download_geography)
 export(get_geoinfo)
 importFrom(magrittr,"%>%")
+importFrom(rlang,.data)

R/canmap-package.R

@@ -0,0 +1,10 @@
+#' @keywords internal
+"_PACKAGE"
+
+#' @importFrom rlang .data
+
+# The following block is used by usethis to automatically manage
+# roxygen namespace tags. Modify with care!
+## usethis namespace: start
+## usethis namespace: end
+NULL

R/code_book.R

@@ -0,0 +1,14 @@
+#' Metadata directory for Canadian geographic datasets
+#'
+#' Code positions, names and definitions of geographic metadata
+#'
+#'
+#' @format A data frame.
+#' \describe{
+#'   \item{code_type}{The type of code, (e.g., \code{geo_level})}
+#'   \item{code}{Code occurring in shapefile filenames (e.g., \code{geo_level})}
+#'   \item{code_desc}{Short description of the code value}
+#' }
+#' @source \url{https://www150.statcan.gc.ca/n1/pub/92-196-x/92-196-x2016001-eng.htm}
+"code_book"
+

R/code_pos.R

@@ -0,0 +1,14 @@
+#' Directory of metadata character positions for Canadian geographic datasets
+#'
+#' Code positions of geographic metadata in filenames
+#'
+#'
+#' @format A data frame.
+#' \describe{
+#'   \item{code_type}{The type of code, (e.g., \code{geo_level})}
+#'   \item{start_chr}{Start position of the code in the filename (e.g., 2 = start of \code{geo_level})}
+#'   \item{stop_chr}{End position of the code in the filename (e.g., 4 = end of \code{geo_level})}
+#' }
+#' @source \url{https://www150.statcan.gc.ca/n1/pub/92-196-x/92-196-x2016001-eng.htm}
+"code_pos"
+

R/download_geography.R

@@ -6,8 +6,6 @@
 #' @format A data frame.
 #' \describe{
 #'   \item{filepath}{The name of the file.}
-#'   \item{ext}{Extension: .zip}
-#'   \item{type}{File or directory.}
 #'   \item{size}{Zipped file size.}
 #'   \item{path}{Url (external) or filepath (internal.)}
 #'   \item{ref_date}{Year of the geography, usually Census year.}
@@ -17,9 +15,8 @@
 #'   \item{file_type}{Cartographic or digital boundary file.}
 #'   \item{format}{Arcgis (.shp), or MapInfo or some other one.}
 #'   \item{projection}{lat/long or Lambert conformal conic.}
-#'   \item{geo_coverage}{ = Canada.}
 #'   \item{language}{English or French.}
 #' }
 #' @source \url{https://www150.statcan.gc.ca/n1/pub/92-196-x/92-196-x2016001-eng.htm}
-"shapefile_info"
+"shapefile_paths"
 

R/get_geoinfo.R

@@ -1,5 +1,110 @@
+## Utility functions for Canadian geographic shapefiles and filenames
 
 
 
 
+#' Download and unzip Canadian shapefiles
+#'
+#' Download and unzip Canadian shapefiles from Statistics Canada
+#'
+#' @param geo_path Full path/url to zipped shapefile
+#' @param geo_dir Directory to download to --- may not keep this.
+#'
+#'
+#' @export
+#'
+#' @return A tibble of shapefiles along with metadata, including
+#' \code{filepath}, \code{size}, \code{path},
+#' \code{ref_date}, \code{geo_code}, \code{geo_level},
+#' \code{file_type}, \code{format}, \code{projection},
+#' and \code{language}.
+#'
+#' @examples
+#' \donttest{
+#' download_geography("http://www12.statcan.gc.ca/census-recensement/2011/
+#' geo/bound-limit/files-fichiers/2016/lpr_000a16a_e.zip")
+#' }
+download_geography <- function(geo_path, geo_dir = NULL) {
 
+  file_name <- fs::path_file(geo_path)
+  geo_folder_name <-  fs::path_ext_remove(file_name)
+
+  if (is.null(geo_dir)) {
+    geo_dir <- here::here("geography", geo_folder_name)
+  }
+
+  temp <- tempfile()
+
+  utils::download.file(geo_path, temp)
+
+  unzipped_files <- utils::unzip(temp, exdir = geo_dir)
+
+  unlink(temp)
+
+  shp_path <- stringr::str_subset(unzipped_files, pattern = ".shp")
+
+  shp_path
+}
+
+
+
+#' Get metadata associated with geographic filename.
+#'
+#' Get metadata associated with geographic filename.
+#'
+#' @param filename Name of geography file
+#'
+#' @export
+#'
+#' @return A one-row tibble of metadata associated with the filename
+#' of Statistics Canada's shapefiles.
+#'
+#' @examples
+#' \donttest{
+#' get_geoinfo("lpr_000a16a_e")
+#' }
+get_geoinfo <- function(filename) {
+
+  # yy <- canmap::code_pos %>%
+  #   dplyr::mutate(code = stringr::str_sub(filename, start_chr, stop_chr)) %>%
+  #   dplyr::select(-start_chr, -stop_chr)
+  #
+  # z <- yy %>%
+  #   dplyr::left_join(canmap::code_book %>% dplyr::select(code_type, code, code_desc, long_desc), by = c("code_type", "code")) %>%
+  #   dplyr::select(code_type, code_desc) %>%
+  #   tidyr::spread(code_type, code_desc)
+  #
+  # z$geo_code <- yy %>%
+  #   dplyr::filter(code_type == "geo_level") %>%
+  #   dplyr::pull(code)
+  #
+  # z %>%
+  #   dplyr::mutate(filename = filename) %>%
+  #   dplyr::select(filename, ref_date, geo_code, geo_level, file_type, format, projection, geo_coverage, language)
+  extract_codes <- code_pos
+
+  extract_codes$code <- stringr::str_sub(filename,
+                                         code_pos$start_chr,
+                                         code_pos$stop_chr)
+
+  extract_codes[, c("start_chr", "stop_chr")] <- NULL
+
+  code_descriptions <- dplyr::left_join(extract_codes,
+                                        canmap::code_book,
+                                        by = c("code_type", "code"))
+  code_descriptions[, "code"] <- NULL
+  code_descriptions <- tidyr::spread(code_descriptions,
+                                     .data$code_type,
+                                     .data$code_desc)
+
+
+
+  code_descriptions$geo_code <- extract_codes[extract_codes$code_type == "geo_level", ]$code
+  code_descriptions$filename <- filename
+
+  dplyr::select(code_descriptions, .data$filename, .data$ref_date,
+                .data$geo_code, .data$geo_level, .data$file_type,
+                .data$format, .data$projection, .data$geo_coverage,
+                .data$language)
+
+}

R/shapefile_info.R R/shapefile_paths.RR/shapefile_info.R renamed to R/shapefile_paths.R

@@ -33,10 +33,10 @@ remotes::install_github("tweed1e/canmap")
 ```{r example}
 library(canmap)
 
-tibble::as_tibble(shapefile_info)
+tibble::as_tibble(shapefile_paths)
 
 # then pick a shapefile and get the link:
-shapefile_info[1, c("filepath", "path")]
+shapefile_paths[1, c("filepath", "path")]
 ```