importArms: Import Study Arm Names

Description

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.

Usage

importArms(rcon, arms_data, override = FALSE, ...)
# S3 method for redcapApiConnection
importArms(
  rcon,
  arms_data,
  override = FALSE,
  ...,
  error_handling = getOption("redcap_error_handling")
)

Value

No value is returned.

Arguments

rcon: A REDCap connection object as generated by redcapConnection.
arms_data: 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.
override: 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.
error_handling: An option for how to handle errors returned by the API. see redcap_error

REDCap API Documentation

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.

REDCap Version

At least 8.1.17+ (and likely some earlier versions)

References

Please refer to your institution's API documentation.