exportNextRecordName: Generate Next Record Name from a REDCap Database

Description Usage Arguments Details Value REDCap API Documentation REDCap Version Author(s) References

View source: R/exportNextRecordName.R

Description

To be used by projects with record auto-numbering enabled, this method exports the next potential record ID for a project.

Usage

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

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

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

Arguments

rcon

A REDCap connection object as generated by redcapConnection

...

Arguments to be passed to other methods.

error_handling

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

Details

It generates the next record name by determining the current maximum numerical record ID and then incrementing it by one.

Value

Returns the maximum integer record ID + 1.

REDCap API Documentation

NOTE: This method does not create a new record, but merely determines what the next record name would be.

REDCap Version

8.1.8+

Author(s)

Xuefei Jia

References

Please refer to your institution's API documentation.

Additional details on API parameters are found on the package wiki at https://github.com/nutterb/redcapAPI/wiki/REDCap-API-Parameters


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