Merge pull request #303 from OuhscBbmc/dev

Dev

Author: wibeasley

.github/ISSUE_TEMPLATE/unexpected-behavior-issue-template.md

@@ -7,27 +7,25 @@ assignees: ''
 
 ---
 
-**Describe the behavior**
-Please provide a clear and concise description of the scenario and the behavior.  *Be careful not to include tokens, PHI (protected health information), or other information that should not be public!*
+Thank you for taking the time to file an issue.  Here are some suggestions for writing your issue that should let us respond and help you more quickly.
 
-**Troubleshooter Results**
-Please carefully reread the [Troubleshooting Vignette](https://ouhscbbmc.github.io/REDCapR/articles/TroubleshootingApiCalls.html) and thoroughly describe which part(s) doesn't work.  Many people have contributed to this document; it is likely that it will help precisely identify the location of the problem, which will help us respond with better advice.
+**Troubleshooter**: Please carefully reread the [Troubleshooting Vignette](https://ouhscbbmc.github.io/REDCapR/articles/TroubleshootingApiCalls.html) and thoroughly describe which parts don't work.  
 
-If you have advice for improving the [Troubleshooter](https://ouhscbbmc.github.io/REDCapR/articles/TroubleshootingApiCalls.html) or [this issue template](https://github.com/OuhscBbmc/REDCapR/blob/master/.github/ISSUE_TEMPLATE/unexpected-behavior-issue-template.md), we'd love to hear about it.
+**Describe the behavior**: Please provide a clear and concise description of the scenario and the behavior.  *Be careful not to include tokens, PHI (protected health information), or other information that should not be public!*
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+**Expected behavior**: A clear and concise description of what you expected to happen.
+
 
 **Desktop (please complete the following information):**
  - OS: [e.g. Windows 10]
  - REDCap version [e.g. 9.0.1 --look at the bottom of the REDCap web page]
  - REDCapR Version [e.g. 0.10.2.9005  --run `packageVersion("REDCapR")`]
 
 
-**Additional context**
-Add any other context about the problem here.
+**Additional context**: Add any other information about the specific problem, such as a data dictionary or screenshot.
+
 
-*Remember, don't include tokens, PHI, or other information that should not be public.*
+**Thank you and reminder**: 
+  * Many people have contributed to this package and it's documentation, and it's continually improving.  If you have advice for improving the documentation, the [Troubleshooter](https://ouhscbbmc.github.io/REDCapR/articles/TroubleshootingApiCalls.html), or [this issue template](https://github.com/OuhscBbmc/REDCapR/blob/master/.github/ISSUE_TEMPLATE/unexpected-behavior-issue-template.md), we'd love to hear it.
+  * *Remember, don't include tokens, PHI, or other information that should not be public.*

DESCRIPTION

@@ -6,7 +6,7 @@ Description: Encapsulates functions to streamline calls from R to the REDCap
     University.  The Application Programming Interface (API) offers an avenue
     to access and modify data programmatically, improving the capacity for
     literate and reproducible programming.
-Version: 0.10.2.9006
+Version: 0.11.0
 Authors@R: c(person("Will", "Beasley", role = c("aut", "cre"), email =
     "wibeasley@hotmail.com", comment = c(ORCID = "0000-0002-5613-5006")),
     person("David", "Bard", role = "ctb"),
@@ -18,7 +18,8 @@ Authors@R: c(person("Will", "Beasley", role = c("aut", "cre"), email =
     role = "ctb"), person("Hao", "Zhu",
     role = "ctb",
     comment = c(ORCID = '0000-0002-3386-6076')), person("Felix", "Torres",
-    role = "ctb", email = "fetorres@ucsd.edu"))
+    role = "ctb", email = "fetorres@ucsd.edu"), person("Philip", "Chase",
+    role = "ctb", email = "pbc@ufl.edu"))
 URL: https://github.com/OuhscBbmc/REDCapR, http://ouhsc.edu/bbmc/,
     http://project-redcap.org
 BugReports: https://github.com/OuhscBbmc/REDCapR/issues

NEWS.md

@@ -4,7 +4,7 @@ Upcoming Versions
 In the future:
 ...
 
-Version 0.11 (Released ?)
+Version 0.11 (Released 2020-04-20)
 ==========================================================
 
 ### Breaking Changes (possible, but unlikely)
@@ -25,7 +25,7 @@ Version 0.11 (Released ?)
 
 ### Stability Features
 
-* `httr::content()` (which is inside `kernel_api()`) now processes the returned value as "text/csv", by default.  This should prevent strange characters from tricking the process as the internal variable `raw_text` is being formed. See the [httr::content()`](https://httr.r-lib.org/reference/content.html) documentation for a list of possible values for the `content_type` parameter.  (Thanks to great debugging by @vortexing, #269)
+* `httr::content()` (which is inside `kernel_api()`) now processes the returned value as "text/csv", by default.  This should prevent strange characters from tricking the process as the internal variable `raw_text` is being formed. See the [httr::content()`](https://httr.r-lib.org/reference/content.html) documentation for a list of possible values for the `content_type` parameter.  (Thanks to great debugging by @vortexing #269, @sybandrew #272, & @begavett, #290)
 
 * Similarly, `kernel_api()` now has an `encoding` parameter, which defaults to "UTF-8".  (#270)
 

R/redcap-download-file-oneshot.R

@@ -18,6 +18,13 @@
 #' Required
 #' @param event The name of the event where the file is saved in REDCap.
 #' Optional
+#' @param repeat_instrument The name of the instrument that is repeating
+#' for a given event.
+#' Optional
+#' @param repeat_instance (only for projects with repeating instruments/events)
+#' The repeat instance number of the repeating event (if longitudinal) or the
+#' repeating instrument (if classic or longitudinal). Default value is '1'.
+#' Optional
 #' @param verbose A boolean value indicating if `message`s should be printed
 #' to the R console during the operation.  Optional.
 #' @param config_options  A list of options to pass to [httr::POST()] method
@@ -101,6 +108,8 @@ redcap_download_file_oneshot <- function(
   record,
   field,
   event           = "",
+  repeat_instrument = NULL,
+  repeat_instance = NULL,
   verbose         = TRUE,
   config_options  = NULL
 ) {
@@ -132,6 +141,14 @@ redcap_download_file_oneshot <- function(
 
   if (0L < nchar(event)) post_body$event <- event
 
+  if (!is.null(repeat_instrument)) {
+      if (is.null(repeat_instance)) {
+          stop("You must specify repeat_instance when specified repeat_instrement");
+      }
+      post_body$repeat_instrument <- repeat_instrument
+      post_body$repeat_instance   <- repeat_instance
+  }
+
   # This is the first of two important lines in the function.
   #   It retrieves the information from the server and stores it in RAM.
   kernel <- kernel_api(redcap_uri, post_body, config_options)

_pkgdown.yml

@@ -50,6 +50,7 @@ reference:
       - redcap_next_free_record_name
       - redcap_metadata_read
       - redcap_metadata_write
+      - redcap_survey_link_export_oneshot
       - redcap_users_export
       - redcap_variables
       - redcap_version

cran-comments.md

@@ -1,24 +1,22 @@
 Description
 -----------------------------------------------
-This submission includes new features and also addresses some (soon-to-be) breaking changes in the libraries underneath.
-
-I have fixed the three points described in your previous response (documented in [our issue](https://github.com/OuhscBbmc/REDCapR/issues/253)).  For the first point, I fixed some markdown syntax so  the API's url is correctly interpreted.  I'm sorry the test builds below didn't uncover the last two.
+This submission includes new features and also addresses a recent breaking change from tibble 3.0.0 (https://github.com/OuhscBbmc/REDCapR/issues/302).
 
 Thank you for taking the time to review my submission, and please tell me if there's something else I should do for CRAN.  -Will Beasley
 
 
 Test environments
 -----------------------------------------------
 
-1. Local Ubuntu, R 3.6.1 patched
-1. Local Win8, R 3.6.1 patched
+1. Local Ubuntu, R 3.6.3 patched
+1. Local Win8, R 4.0.0 RC
 1. r-hub
-    1. [Ubuntu Linux 16.04 LTS, R-release, GCC](https://builder.r-hub.io/status/REDCapR_0.10.1.tar.gz-ffc36a958fe44f3fb3263929670f8138)
-    1. [Fedora Linux, R-devel, clang, gfortran](https://builder.r-hub.io/status/REDCapR_0.10.1.tar.gz-2e2bed0d3cda44429a8f830c2b9d8e92)
-    1. [Windows Server](https://builder.r-hub.io/status/REDCapR_0.10.1.tar.gz-0c79ee0f9b3e49f7b381348e9f7283b0)
-1. [win-builder](https://win-builder.r-project.org/a9ub2IBAb24W), development version.
+    1. [Ubuntu Linux 16.04 LTS, R-release, GCC](https://builder.r-hub.io/status/REDCapR_0.10.2.9006.tar.gz-71151f2f04454bc18c16430e5d62610b)
+    1. [Fedora Linux, R-devel, clang, gfortran](https://builder.r-hub.io/status/REDCapR_0.10.2.9006.tar.gz-2f619028b765442f9dc1c34373443d2a)
+    1. [Windows Server](https://builder.r-hub.io/status/REDCapR_0.10.2.9006.tar.gz-80133501925a411da4c3cf3be8205e29)
+1. [win-builder](https://win-builder.r-project.org/xYyWrC1uFjXH), development version.
 1. [Travis CI](https://travis-ci.org/OuhscBbmc/REDCapR), Ubuntu 14.04 LTS
-1. [AppVeyor](https://ci.appveyor.com/project/wibeasley/REDCapR), Windows Server 2012
+1. [AppVeyor](https://ci.appveyor.com/project/wibeasley/REDCapR), Windows Server 2012 R2
 
 
 R CMD check results