added r cmd check. Update documentation.

Author: jacobaclarke

.Rbuildignore

@@ -1 +1,6 @@
 ^LICENSE\.md$
+_pkgdown.yml
+docs
+generate.R
+.github
+^\.github$

.github/workflows/R-CMD-check.yaml

@@ -0,0 +1,46 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+name: R-CMD-check
+
+jobs:
+  R-CMD-check:
+    runs-on: ${{ matrix.config.os }}
+
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: macOS-latest,   r: 'release'}
+          - {os: windows-latest, r: 'release'}
+          - {os: ubuntu-latest,   r: 'devel', http-user-agent: 'release'}
+          - {os: ubuntu-latest,   r: 'release'}
+          - {os: ubuntu-latest,   r: 'oldrel-1'}
+
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      R_KEEP_PKG_SOURCE: yes
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: r-lib/actions/setup-pandoc@v1
+
+      - uses: r-lib/actions/setup-r@v1
+        with:
+          r-version: ${{ matrix.config.r }}
+          http-user-agent: ${{ matrix.config.http-user-agent }}
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v1
+        with:
+          extra-packages: rcmdcheck
+
+      - uses: r-lib/actions/check-r-package@v1

DESCRIPTION

@@ -3,12 +3,12 @@ Title: Provides downloads of the IDDR Data
 Version: 0.0.0.9000
 Authors@R: 
     c(person("Jacob", "Clarke", , "[email protected]", role = c("aut", "cre"),
-           comment = c(ORCID = "0000-0002-7221-6244")), person("Timothy", "Wiemken"))
+           comment = c(ORCID = "0000-0002-7221-6244")), person("Timothy", "Wiemken", role = c("aut")))
 Description: Provides downloads of the IDDR data
 License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.1.2
+RoxygenNote: 7.2.0
 Imports: 
     rappdirs,
     janitor,

R/cache_download.R

@@ -10,6 +10,7 @@
 #' @param use_memory Whether to use memory caching.
 #' @param use_disk Whether to use disk caching.
 #' @param bust_cache Whether to bust (refresh) the cache.
+#' @param ... arguments to forward to the vroom::vroom function.
 cache_download <- function(url, ..., use_memory = TRUE, use_disk = TRUE, bust_cache = FALSE) {
   use_disk <- getOption("tidyiddr_use_cache", use_disk)
   cache_dir <- getOption("tidyiddr_cache_dir", rappdirs::user_cache_dir("tidyiddr"))
@@ -29,7 +30,7 @@ cache_download <- function(url, ..., use_memory = TRUE, use_disk = TRUE, bust_ca
     } else {
       download_data()
 
-      write.csv(get(memory), path, row.names = FALSE)
+      utils::write.csv(get(memory), path, row.names = FALSE)
     }
   }
 

R/generated.R

@@ -39,6 +39,7 @@ raw %>%
 #' @param use_memory Whether to use memory caching.
 #' @param use_disk Whether to use disk caching.
 #' @param bust_cache Whether to bust (refresh) the cache.
+#' @param ... arguments to forward to the cache_download function.
 {{name}} <- function(use_memory = T, use_disk = T, bust_cache = F, ...) {
   {{ifelse(grepl('\\\\.', name),
         paste('print(\"', name, 'is deprecated. Please use', gsub('\\\\.', '_', name), 'instead\")' ),