Add function reference, close #3

itsleeds · Apr 22, 2024 · 11fc4fc · 11fc4fc
1 parent fd588c9
commit 11fc4fc
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 2 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,2 +1,3 @@
 # Generated by roxygen2: do not edit by hand
 
+export(download_and_read)
diff --git a/R/opsnap.R b/R/opsnap.R
@@ -1,4 +1,16 @@
-download_and_read = function(u, remove_nas = TRUE, dir = "raw_data/west-yorkshire", filter_nas = FALSE) {
+#' Download and read data from opsnap project
+#' 
+#' @param u URL of data
+#' @param remove_nas Remove NA values?
+#' @param dir Download directory
+#' @return Data frame
+#' @export
+#' @examples
+#' if (FALSE) {
+#' u = "https://www.westyorkshire.police.uk/sites/default/files/2023-10/operation_snap_july-sept_2023.xlsx"
+#' download_and_read(, dir = ".")
+#' }
+download_and_read = function(u, remove_nas = TRUE, dir = "raw_data/west-yorkshire") {
     tmp = file.path(dir, basename(u))
     if (!file.exists(tmp)) {
         utils::download.file(u, tmp, mode = "wb")
@@ -8,7 +20,7 @@ download_and_read = function(u, remove_nas = TRUE, dir = "raw_data/west-yorkshir
     })
     names(d) = clean_names(names(d))
     d = select_columns(d)
-    if (filter_nas) {
+    if (remove_nas) {
         d = filter_nas(d)
     }
     return(d)

diff --git a/man/download_and_read.Rd b/man/download_and_read.Rd