importFiles: Imports a File to REDCap to Attach to a Record

Description

A single file may be attached to a single record. The behavior of this function is consistent with the behavior of the API, which only allows one file to be uploaded at a time

Usage

importFiles(
  rcon,
  file,
  record,
  field,
  event,
  overwrite = TRUE,
  ...,
  bundle = NULL,
  repeat_instance = NULL
)
# S3 method for redcapDbConnection
importFiles(
  rcon,
  file,
  record,
  field,
  event,
  overwrite = TRUE,
  ...,
  bundle = NULL,
  repeat_instance = NULL
)
# S3 method for redcapApiConnection
importFiles(
  rcon,
  file,
  record,
  field,
  event = NULL,
  overwrite = TRUE,
  repeat_instance = NULL,
  ...,
  bundle = NULL,
  error_handling = getOption("redcap_error_handling")
)

Arguments

rcon: A REDCap connection object as generated by redcapConnection
file: Character string giving the file path to the file to be imported.
record: The record ID in which the desired file is stored. Must be length 1.
field: The field name in which the file is stored. Must be length 1.
event: The event name for the file. Must be length 1. This applies only to longitudinal projects. If the event is not supplied for a longitudinal project, the API will return an error
overwrite: Logical. When FALSE, the function checks if a file already exists for that record. If a file exists, the function terminates to prevent overwriting. When TRUE, no additional check is performed.
...: Arguments to be passed to other methods
bundle: A redcapBundle object as created by exportBundle.
repeat_instance: The repeat instance number of the repeating event or the repeating instrument. When available in your instance of REDCap, and passed as NULL, the API will assume a value of 1.
error_handling: An option for how to handle errors returned by the API. see redcap_error

Author

Benjamin Nutter

Details

The function may only import a single file