exportLogging {redcapAPI} | R Documentation |
Export Logging Records
Description
These methods enable to user to export the logging (audit trail) of all changes made to a project, including data exports, data changes, project metadata changes, modification of user rights, etc.
Usage
exportLogging(
rcon,
logtype = character(0),
user = character(0),
record = character(0),
dag = character(0),
beginTime = .POSIXct(character(0)),
endTime = .POSIXct(character(0)),
...
)
## S3 method for class 'redcapApiConnection'
exportLogging(
rcon,
logtype = character(0),
user = character(0),
record = character(0),
dag = character(0),
beginTime = as.POSIXct(character(0)),
endTime = as.POSIXct(character(0)),
...,
error_handling = getOption("redcap_error_handling"),
config = list(),
api_param = list()
)
Arguments
rcon |
A |
logtype |
|
user |
|
record |
|
dag |
|
beginTime |
|
endTime |
|
... |
Arguments to pass to other methods |
error_handling |
|
config |
A named |
api_param |
A named |
Value
Returns a data frame with columns
timestamp | The date/time of the logging record. |
username | The user name of the user that performed the action being logged. |
action | The classification of action being logged. |
details | Details of the action being logged. |
record | The record ID associated with the action being logged. When not related to a record, this will be NA |
Examples
## Not run:
unlockREDCap(connections = c(rcon = "project_alias"),
url = "your_redcap_url",
keyring = "API_KEYs",
envir = globalenv())
# Export all of the logging events
exportLogging(rcon)
# Export all of the events for record '2'
exportLogging(rcon,
record = "2")
# Export all of the events where a record was deleted
exportLoging(rcon,
logtype = "record_delete")
## End(Not run)