OuhscBbmc / REDCapR

@@ -71,6 +71,13 @@
Loading
71 71
#' [POSIXct](https://stat.ethz.ch/R-manual/R-devel/library/base/html/as.POSIXlt.html)
72 72
#' value.
73 73
#' If not specified, REDCap will assume no end time.
74 +
#' @param blank_for_gray_form_status A boolean value that specifies whether
75 +
#' or not to export blank values for instrument complete status fields that have
76 +
#' a gray status icon. All instrument complete status fields having a gray icon
77 +
#' can be exported either as a blank value or as "0" (Incomplete). Blank values
78 +
#' are recommended in a data export if the data will be re-imported into a
79 +
#' REDCap project. Default is `FALSE`.
80 +
#'
74 81
#' @param col_types A [readr::cols()] object passed internally to
75 82
#' [readr::read_csv()].  Optional.
76 83
#' @param guess_type A boolean value indicating if all columns should be
@@ -196,6 +203,7 @@
Loading
196 203
  filter_logic                  = "",
197 204
  datetime_range_begin          = as.POSIXct(NA),
198 205
  datetime_range_end            = as.POSIXct(NA),
206 +
  blank_for_gray_form_status    = FALSE,
199 207
200 208
  col_types                     = NULL,
201 209
  guess_type                    = TRUE,
@@ -227,6 +235,7 @@
Loading
227 235
  checkmate::assert_logical(  export_data_access_groups , any.missing=FALSE,     len=1)
228 236
  checkmate::assert_posixct(  datetime_range_begin      , any.missing=TRUE , len=1, null.ok=TRUE)
229 237
  checkmate::assert_posixct(  datetime_range_end        , any.missing=TRUE , len=1, null.ok=TRUE)
238 +
  checkmate::assert_logical( blank_for_gray_form_status , any.missing=FALSE, len=1)
230 239
231 240
  checkmate::assert_logical(  guess_type                , any.missing=FALSE,     len=1)
232 241
  if (!is.null(guess_max)) warning("The `guess_max` parameter in `REDCapR::redcap_read()` is deprecated.")
@@ -278,6 +287,7 @@
Loading
278 287
    filter_logic       = filter_logic,
279 288
    datetime_range_begin   = datetime_range_begin,
280 289
    datetime_range_end     = datetime_range_end,
290 +
    blank_for_gray_form_status = blank_for_gray_form_status,
281 291
    guess_type         = guess_type,
282 292
    http_response_encoding = http_response_encoding,
283 293
    locale             = locale,
@@ -352,6 +362,7 @@
Loading
352 362
      filter_logic                = filter_logic,
353 363
      datetime_range_begin        = datetime_range_begin,
354 364
      datetime_range_end          = datetime_range_end,
365 +
      blank_for_gray_form_status  = blank_for_gray_form_status,
355 366
356 367
      col_types                   = col_types,
357 368
      guess_type                  = FALSE,

@@ -55,6 +55,12 @@
Loading
55 55
#' (https://stat.ethz.ch/R-manual/R-devel/library/base/html/as.POSIXlt.html)
56 56
#' value.
57 57
#' If not specified, REDCap will assume no end time.
58 +
#' @param blank_for_gray_form_status A boolean value that specifies whether
59 +
#' or not to export blank values for instrument complete status fields that have
60 +
#' a gray status icon. All instrument complete status fields having a gray icon
61 +
#' can be exported either as a blank value or as "0" (Incomplete). Blank values
62 +
#' are recommended in a data export if the data will be re-imported into a
63 +
#' REDCap project. Default is `FALSE`.
58 64
#'
59 65
#' @param verbose A boolean value indicating if `message`s should be printed
60 66
#' to the R console during the operation.  The verbose output might contain
@@ -155,6 +161,7 @@
Loading
155 161
  filter_logic                  = "",
156 162
  datetime_range_begin          = as.POSIXct(NA),
157 163
  datetime_range_end            = as.POSIXct(NA),
164 +
  blank_for_gray_form_status    = FALSE,
158 165
159 166
  # placeholder: guess_type
160 167
  # placeholder: guess_max
@@ -183,6 +190,7 @@
Loading
183 190
  checkmate::assert_character(filter_logic              , any.missing=FALSE, len=1, pattern="^.{0,}$")
184 191
  checkmate::assert_posixct(  datetime_range_begin      , any.missing=TRUE , len=1, null.ok=TRUE)
185 192
  checkmate::assert_posixct(  datetime_range_end        , any.missing=TRUE , len=1, null.ok=TRUE)
193 +
  checkmate::assert_logical( blank_for_gray_form_status , any.missing=FALSE, len=1)
186 194
187 195
  # placeholder: checkmate::assert_logical(  guess_type                , any.missing=FALSE, len=1)
188 196
  # placeholder: checkmate::assert_integerish(guess_max                , any.missing=FALSE, len=1, lower=1)
@@ -215,7 +223,8 @@
Loading
215 223
    exportDataAccessGroups  = export_data_access_groups,
216 224
    filterLogic             = filter_logic,
217 225
    dateRangeBegin          = datetime_range_begin,
218 -
    dateRangeEnd            = datetime_range_end
226 +
    dateRangeEnd            = datetime_range_end,
227 +
    exportBlankForGrayFormStatus = blank_for_gray_form_status
219 228
    # record, fields, forms & events are specified below
220 229
  )
221 230

@@ -58,6 +58,13 @@
Loading
58 58
#' [POSIXct](https://stat.ethz.ch/R-manual/R-devel/library/base/html/as.POSIXlt.html)
59 59
#' value.
60 60
#' If not specified, REDCap will assume no end time.
61 +
#' @param blank_for_gray_form_status A boolean value that specifies whether
62 +
#' or not to export blank values for instrument complete status fields that have
63 +
#' a gray status icon. All instrument complete status fields having a gray icon
64 +
#' can be exported either as a blank value or as "0" (Incomplete). Blank values
65 +
#' are recommended in a data export if the data will be re-imported into a
66 +
#' REDCap project. Default is `FALSE`.
67 +
#'
61 68
#' @param col_types A [readr::cols()] object passed internally to
62 69
#' [readr::read_csv()].  Optional.
63 70
#' @param guess_type A boolean value indicating if all columns should be
@@ -181,6 +188,7 @@
Loading
181 188
  filter_logic                  = "",
182 189
  datetime_range_begin          = as.POSIXct(NA),
183 190
  datetime_range_end            = as.POSIXct(NA),
191 +
  blank_for_gray_form_status    = FALSE,
184 192
185 193
  col_types                     = NULL,
186 194
  guess_type                    = TRUE,
@@ -212,6 +220,7 @@
Loading
212 220
  checkmate::assert_character(filter_logic              , any.missing=FALSE, len=1, pattern="^.{0,}$")
213 221
  checkmate::assert_posixct(  datetime_range_begin      , any.missing=TRUE , len=1, null.ok=TRUE)
214 222
  checkmate::assert_posixct(  datetime_range_end        , any.missing=TRUE , len=1, null.ok=TRUE)
223 +
  checkmate::assert_logical( blank_for_gray_form_status , any.missing=FALSE, len=1)
215 224
216 225
  checkmate::assert_logical(  guess_type                , any.missing=FALSE, len=1)
217 226
  checkmate::assert_integerish(guess_max                , any.missing=FALSE, len=1, lower=1)
@@ -249,7 +258,8 @@
Loading
249 258
    exportDataAccessGroups  = tolower(as.character(export_data_access_groups)),
250 259
    filterLogic             = filter_logic,
251 260
    dateRangeBegin          = datetime_range_begin,
252 -
    dateRangeEnd            = datetime_range_end
261 +
    dateRangeEnd            = datetime_range_end,
262 +
    exportBlankForGrayFormStatus = blank_for_gray_form_status
253 263
    # record, fields, forms & events are specified below
254 264
  )
255 265
Files Coverage
R 95.79%
Project Totals (38 files) 95.79%
1
comment: false
2

3
coverage:
4
  status:
5
    project:
6
      default:
7
        target: auto
8
        threshold: 3%
9
    patch:
10
      default:
11
        target: auto
12
        threshold: 3%
Sunburst
The inner-most circle is the entire project, moving away from the center are folders then, finally, a single file. The size and color of each slice is representing the number of statements and the coverage, respectively.
Icicle
The top section represents the entire project. Proceeding with folders and finally individual files. The size and color of each slice is representing the number of statements and the coverage, respectively.
Grid
Each block represents a single file in the project. The size and color of each block is represented by the number of statements and the coverage, respectively.
Loading