Import Arms into a project or to rename existing Arms in a
project. You may use the parameter override = TRUE as a 'delete
all + import' action in order to erase all existing Arms in the
project while importing new Arms. Notice: Because of the 'override'
parameter's destructive nature, this method may only use
override = TRUE for projects in Development status.
importArms(rcon, arms_data, override = FALSE, ...)# S3 method for redcapApiConnection
importArms(
rcon,
arms_data,
override = FALSE,
refresh = TRUE,
...,
error_handling = getOption("redcap_error_handling"),
config = list(),
api_param = list()
)
No value is returned.
A REDCap connection object as generated by
redcapConnection.
A data.frame with two columns. The first column
is an integer-like value with the name arm_num. The second is
a character value with the name name.
logical(1). When TRUE, the action is to
delete all of the arms in the project and import the contents of
arms_data. The default setting is FALSE, which only
allows arms to be renamed or added.
additional arguments to pass to other methods.
logical(1). If TRUE, the cached data will
be refreshed after the import.
An option for how to handle errors returned by the API.
see redcap_error
list Additional configuration parameters to pass to
POST. These are appended to any parameters in
rcon$config.
list Additional API parameters to pass into the
body of the API call. This provides users to execute calls with options
that may not otherwise be supported by redcapAPI.
This method allows you to import Arms into a project or to rename existing Arms in a project. You may use the parameter override=1 as a 'delete all + import' action in order to erase all existing Arms in the project while importing new Arms. Notice: Because of the 'override' parameter's destructive nature, this method may only use override=1 for projects in Development status.
NOTE: This only works for longitudinal projects.
At least 8.1.17+ (and likely some earlier versions)
Please refer to your institution's API documentation.