redcapAPI (version 2.8.0)

recordsManagementMethods: Export Next Record Name or Rename a Record

Description

These methods enable the user to get the next record name (when auto numbering is enabled) or rename and existing record.

Usage

exportNextRecordName(rcon, ...)
renameRecord(rcon, record_name, new_record_name, arm = NULL, ...)
# S3 method for redcapApiConnection
exportNextRecordName(
  rcon,
  ...,
  error_handling = getOption("redcap_error_handling"),
  config = list(),
  api_param = list()
)
# S3 method for redcapApiConnection
renameRecord(
  rcon,
  record_name,
  new_record_name,
  arm = NULL,
  ...,
  error_handling = getOption("redcap_error_handling"),
  config = list(),
  api_param = list()
)

Value

exportNextRecordName returns an integerish value. The value is determined by looking up the highest record ID number in the project and incrementing it by 1.

renameRecord return a logical value that indicates if the operation was successful.

Arguments

rcon

A redcapConnection object.

record_name

character(1) or integerish(1). The name of an existing record in the project.

new_record_name

character(1) or integerish(1). The new name to give to the record.

arm

character(1) or NULL, an optional arm number. If NULL, then all records with same name across all arms on which it exists (if longitudinal with multiple arms) will be renamed to new record name, otherwise it will rename the record only in the specified arm.

...

Arguments to pass to other methods

error_handling

character(1). One of c("error", "null"). An option for how to handle errors returned by the API. see redcapError().

config

A named list. Additional configuration parameters to pass to httr::POST(). These are appended to any parameters in rcon$config.

api_param

A named 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.

Functions

• exportNextRecordName(): Get the ID number for the next record to be created.

• renameRecord(): Rename an existing record.

See Also

exportRecords(),
exportReports(),
importRecords(),
deleteRecords(),
exportRecordsTyped(),
exportReportsTyped()

Examples

if (FALSE) {
unlockREDCap(connections = c(rcon = "project_alias"), 
             url = "your_redcap_url", 
             keyring = "API_KEYs", 
             envir = globalenv())
             
# Get the next record name
exportNextRecordName(rcon)

# Rename an existing record
renameRecord(rcon, 
             record_name = "1", 
             new_record_name = "42")
}