From 961efb4ad4b07e764e23d91a216e0cad7ee49785 Mon Sep 17 00:00:00 2001 From: Will Beasley Date: Fri, 6 Sep 2024 16:29:27 -0500 Subject: [PATCH] documentation updates ref #529 --- man/redcap_read.Rd | 4 ++++ man/redcap_read_oneshot.Rd | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/man/redcap_read.Rd b/man/redcap_read.Rd index b666a6f8..3738f464 100644 --- a/man/redcap_read.Rd +++ b/man/redcap_read.Rd @@ -25,6 +25,7 @@ redcap_read( datetime_range_end = as.POSIXct(NA), blank_for_gray_form_status = FALSE, col_types = NULL, + na = c("", "NA"), guess_type = TRUE, guess_max = NULL, http_response_encoding = "UTF-8", @@ -117,6 +118,9 @@ REDCap project. Default is \code{FALSE}.} \item{col_types}{A \code{\link[readr:cols]{readr::cols()}} object passed internally to \code{\link[readr:read_delim]{readr::read_csv()}}. Optional.} +\item{na}{A \link{character} vector passed internally to \code{\link[readr:read_delim]{readr::read_csv()}}. +Defaults to \code{c("", "NA")}.} + \item{guess_type}{A boolean value indicating if all columns should be returned as character. If true, \code{\link[readr:read_delim]{readr::read_csv()}} guesses the intended data type for each column. Ignored if \code{col_types} is not null.} diff --git a/man/redcap_read_oneshot.Rd b/man/redcap_read_oneshot.Rd index 46baca4c..49153b7b 100644 --- a/man/redcap_read_oneshot.Rd +++ b/man/redcap_read_oneshot.Rd @@ -21,6 +21,7 @@ redcap_read_oneshot( datetime_range_end = as.POSIXct(NA), blank_for_gray_form_status = FALSE, col_types = NULL, + na = c("", "NA"), guess_type = TRUE, guess_max = 1000, http_response_encoding = "UTF-8", @@ -102,6 +103,9 @@ REDCap project. Default is \code{FALSE}.} \item{col_types}{A \code{\link[readr:cols]{readr::cols()}} object passed internally to \code{\link[readr:read_delim]{readr::read_csv()}}. Optional.} +\item{na}{A \link{character} vector passed internally to \code{\link[readr:read_delim]{readr::read_csv()}}. +Defaults to \code{c("", "NA")}.} + \item{guess_type}{A boolean value indicating if all columns should be returned as character. If true, \code{\link[readr:read_delim]{readr::read_csv()}} guesses the intended data type for each column. Ignored if \code{col_types} is not null.}