List the Files in a ResearchBox — rbox

Lists every file in one or more boxes without downloading them, using one API request per box. A peer-review link's passcode is sent along. Needs an API key (see rbox_token()).

Usage

rbox_files(rb_url, pb = NULL, cache = FALSE)

Arguments

rb_url: a vector of ResearchBox URLs or box IDs
pb: a progress bar passed from another function
cache: if TRUE, reuse a previously cached file list (from this function or rbox_info()) instead of asking ResearchBox again (see repo_info_cache_clear()). Off by default.

Value

a data frame with one row per file: rb_url, name, file_id, section, type, description, extension, size (bytes) and md5, plus an error column when a box could not be listed

Details

ResearchBox limits how often the same box's file list can be requested per hour. A box it refuses has a row with an error starting "API rate limit exhausted: ", so it can be requested again later; cache = TRUE avoids asking again for a box already listed.

Examples

# \donttest{
# needs a ResearchBox API key (see rbox_token())
if (online("researchbox.org") && nzchar(rbox_token())) {
  rbox_files("https://researchbox.org/801")
}
# }