Delete arms from a project. This is a destructive action that will result in deletion of any events and data associated with the arm. Due to its destructive nature, it may only be performed on databases in development status. Data loss is non-reversible.
deleteArms(rcon, arms, ...)# S3 method for redcapApiConnection
deleteArms(
rcon,
arms,
refresh = TRUE,
...,
error_handling = getOption("redcap_error_handling"),
config = list(),
api_param = list()
)
None.
A REDCap connection object as generated by
redcapConnection.
character, a vector of arm numbers that will be
deleted. May also be integerish.
Additional arguments to pass to other methods.
logical(1) If TRUE, the cached arms data will
be refreshed after the deletion.
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 delete Arms from a project. Notice: Because of this method's destructive nature, it is only available for use for projects in Development status. Additionally, please be aware that deleting an arm also automatically deletes all events that belong to that arm, and will also automatically delete any records/data that have been collected under that arm (this is non-reversible data loss).
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.