delete_records: Delete records from a REDCap project

View source: R/delete_records.R

delete_recordsR Documentation

Delete records from a REDCap project

Description

Delete records from a REDCap project

Usage

delete_records(conn, records)

Arguments

conn

A REDCap API connection object (created with rconn)

records

Character vector of record IDs to delete

Value

An integer, the number of records successfully deleted

Examples

## Not run: 
conn <- rconn(
  url = "https://redcap.msf.fr/api/",
  token = Sys.getenv("MY_REDCAP_TOKEN")
)

# delete all records associated with IDs "P004" and "P007"
delete_records(conn, records = c("P004", "P007"))

## End(Not run)


epicentre-msf/redcap documentation built on April 13, 2025, 3:27 a.m.