omnipath_cache_remove: Removes contents from the cache directory

In saezlab/OmnipathR: OmniPath web service client and more

Removes contents from the cache directory

Description

According to the parameters, it can remove contents older than a certain age, or contents having a more recent version, one specific item, or wipe the entire cache.

Usage

omnipath_cache_remove(key = NULL, url = NULL, post = NULL,
    payload = NULL, max_age = NULL, min_age = NULL, status = NULL,
    only_latest = FALSE, wipe = FALSE, autoclean = TRUE)

Arguments

key	The key of the cache record
url	URL pointing to the resource
post	HTTP POST parameters as a list
payload	HTTP data payload
max_age	Age of cache items in days. Remove everything that is older than this age
min_age	Age of cache items in days. Remove everything more recent than this age
status	Remove items having any of the states listed here
only_latest	Keep only the latest version
wipe	Logical: if TRUE, removes all files from the cache and the cache database. Same as calling omnipath_cache_wipe.
autoclean	Remove the entries about failed downloads, the files in the cache directory which are missing from the cache database, and the entries without existing files in the cache directory

Value

Invisibly returns the cache database (list of cache records).

See Also

• omnipath_cache_wipe

• omnipath_cache_clean

• omnipath_cache_autoclean

Examples

## Not run: 
# remove all cache data from the BioPlex database
cache_records <- omnipath_cache_search(
    'bioplex',
    ignore.case = TRUE
)
omnipath_cache_remove(names(cache_records))

# remove a record by its URL
regnetwork_url <- 'http://www.regnetworkweb.org/download/human.zip'
omnipath_cache_remove(url = regnetwork_url)

# remove all records older than 30 days
omnipath_cache_remove(max_age = 30)

# for each record, remove all versions except the latest
omnipath_cache_remove(only_latest = TRUE)

## End(Not run)

bioc_url <- 'https://bioconductor.org/'
version <- omnipath_cache_latest_or_new(url = bioc_url)
httr::GET(bioc_url, httr::write_disk(version$path, overwrite = TRUE))
omnipath_cache_download_ready(version)
key <- omnipath_cache_key(bioc_url)
omnipath_cache_remove(key = key)

saezlab/OmnipathR documentation built on Nov. 10, 2024, 11:02 p.m.