Retrieve info from the OSF by ID

Usage

.osf_info(osf_id, pb = NULL, cache = FALSE)

Arguments

osf_id: an vector of OSF IDs or URLs
pb: a progress bar passed from another function
cache: if TRUE, reuse a previously cached listing for an id already looked up (see repo_info_cache_clear()) instead of re-querying the OSF API. Off by default. Separate from (and in addition to) osf_info()'s own in-memory, session-only cache (options(metacheck.osf.cache = )) – this one is persistent on disk and survives a restart of the script.

Value

a data frame of information

Examples

# \donttest{
if (online("api.osf.io")) {
  .osf_info("pngda")
}
#>   osf_id            name                 description osf_type public category
#> 1  pngda Papercheck Test This is my test description    nodes   TRUE  project
#>   registration preprint                               self
#> 1        FALSE    FALSE https://api.osf.io/v2/nodes/pngda/
#>                                      children
#> 1 https://api.osf.io/v2/nodes/pngda/children/
#>                                      files parent project
#> 1 https://api.osf.io/v2/nodes/pngda/files/   <NA>   pngda
# }