exportProjectInformation: Exports the Project Information

Description

Retrieve a data frame with the project information.

Usage

exportProjectInformation(rcon, ...)
# S3 method for redcapApiConnection
exportProjectInformation(
  rcon,
  ...,
  error_handling = getOption("redcap_error_handling"),
  config = list(),
  api_param = list()
)

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
config: list Additional configuration parameters to pass to POST. These are appended to any parameters in rcon$config.
api_param: 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.

REDCap API Documentation (6.5.0)

This function allows you to export some of the basic attributes of a given REDCap project, such as the project's title, if it is longitudinal, if surveys are enabled, the time the project was created and moved to production, etc.

REDCap Version

6.5.0 (Perhaps earlier)

Known REDCap Limitations

None

Author

Benjamin Nutter

Details

If this function is used in a version of REDCap that does not support the Export Version Number function, the character string 'Version Unknown' is returned.

References

Please refer to your institution's API documentation.

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