View source: R/exportFileRepositoryListing.R
exportFileRepositoryListing | R Documentation |
This method enables the user to export a list of folders and files saved to the File Repository. The listing may optionally include contents of subfolders.
exportFileRepositoryListing(
rcon,
folder_id = numeric(0),
recursive = FALSE,
...
)
## S3 method for class 'redcapApiConnection'
exportFileRepositoryListing(
rcon,
folder_id = numeric(0),
recursive = FALSE,
...
)
rcon |
A |
folder_id |
|
recursive |
|
... |
Arguments to pass to other methods |
Returns a data frame with the columns
folder_id | The REDCap assigned ID value for the folder. Will be NA if the item is a file. |
doc_id | The REDCap assigned ID value for the file. Will be NA if the item is a folder. |
name | The name of the folder of file. |
parent_folder | The ID of the parent folder of the item. The top-level folder is represented as 0. |
exportFromFileRepository()
,
importToFileRepository()
,
deleteFromFileRepository()
,
exportFileRepository()
,
importFileRepository()
,
deleteFileRepository()
,
createFileRepositoryFolder()
## Not run:
unlockREDCap(connections = c(rcon = "project_alias"),
url = "your_redcap_url",
keyring = "API_KEYs",
envir = globalenv())
# Export the top-level listing of the File Repository
exportFileRepositoryListing(rcon)
# Export the complete listing of the File Repository
exportFileRepositoryListing(rcon,
recursive = TRUE)
# Export the listing of a subfolder in the File Repository
exportFileRepositoryListing(rcon,
folder_id = 12345)
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.