deleteArms: Delete Arms From a Project

Description Usage Arguments Value REDCap API Documentation REDCap Version References

View source: R/deleteArms.R

Description

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.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
deleteArms(rcon, arms, ...)

## S3 method for class 'redcapDbConnection'
deleteArms(rcon, arms, ...)

## S3 method for class 'redcapApiConnection'
deleteArms(
  rcon,
  arms,
  ...,
  error_handling = getOption("redcap_error_handling")
)

Arguments

rcon

A REDCap connection object as generated by redcapConnection.

arms

integerish, a vector of arm numbers that will be deleted.

...

Additional arguments to pass to other methods.

error_handling

An option for how to handle errors returned by the API. see redcap_error

Value

None.

REDCap API Documentation

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.

REDCap Version

At least 8.1.17+ (and likely some earlier versions)

References

Please refer to your institution's API documentation.


redcapAPI documentation built on Feb. 18, 2020, 1:09 a.m.