omnipath_cache_update_status: Updates the status of an existing cache record

omnipath_cache_update_statusR Documentation

Updates the status of an existing cache record

Description

Updates the status of an existing cache record

Usage

omnipath_cache_update_status(key, version, status,
    dl_finished = NULL)

Arguments

key

Key of the cache item

version

Version of the cache item. If does not exist a new version item will be created

status

The updated status value

dl_finished

Timestamp for the time when download was finished, if 'NULL' the value remains unchanged

Value

Character: invisibly returns the version number of the cache version item.

Examples

bioc_url <- 'https://bioconductor.org/'
latest_version <- omnipath_cache_latest_or_new(url = bioc_url)
key <- omnipath_cache_key(bioc_url)
omnipath_cache_update_status(
    key = key,
    version = latest_version$number,
    status = 'ready',
    dl_finished = Sys.time()
)
omnipath_cache_remove(url = bioc_url) # cleaning up


saezlab/OmnipathR documentation built on Oct. 16, 2024, 11:49 a.m.