#' @describeIn recordsManagementMethods Rename an existing record.
#' @order 2
#' @export
renameRecord <- function(rcon,
record_name,
new_record_name,
arm = NULL,
...){
UseMethod("renameRecord")
}
#' @rdname recordsManagementMethods
#' @order 4
#' @export
renameRecord.redcapApiConnection <- function(rcon,
record_name,
new_record_name,
arm = NULL,
...){
if (is.numeric(record_name)) record_name <- as.character(record_name)
if (is.numeric(new_record_name)) new_record_name <- as.character(new_record_name)
if (is.numeric(arm)) arm <- as.character(arm)
###################################################################
# Argument Validation ####
coll <- checkmate::makeAssertCollection()
checkmate::assert_class(x = rcon,
classes = "redcapConnection",
add = coll)
checkmate::assert_character(x = record_name,
len = 1,
add = coll)
checkmate::assert_character(x = new_record_name,
len = 1,
add = coll)
checkmate::assert_character(x = arm,
len = 1,
null.ok = TRUE,
add = coll)
checkmate::reportAssertions(coll)
###################################################################
# API Body List ####
body <- list(content = "record",
action = "rename",
record = record_name,
new_record_name = new_record_name,
arm = arm)
###################################################################
# Call the API ####
invisible('1' == as.character(makeApiCall(rcon, body, ...)))
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.