cache: Set or get cache options

In ropensci/fulltext: Full Text of 'Scholarly' Articles Across Many Data Sources

Set or get cache options

Description

Set or get cache options

Usage

cache_options_set(
  path = "fulltext",
  backend = "ext",
  overwrite = FALSE,
  full_path = NULL
)

cache_options_get()

Arguments

path	(character) End of directory path. Default: "fulltext". See Details.
backend	(character) Only "ext" supported for now.
overwrite	(logical) overwrite cached file or not. Default: FALSE
full_path	(character) Full cache path. If given path is ignored.

Value

both functions return the cache options in a named list

Managing cached files

The dafault cache directory is paste0(rappdirs::user_cache_dir(), "/R/fulltext"), but you can set your own path using cache_path_set()

You can alternatively set the entire cache path with the full_path parameter.

You can only pass path or full_path - but not both.

cache_delete only accepts 1 file name, while cache_delete_all doesn't accept any names, but deletes all files. For deleting many specific files, use cache_delete in a lapply() type call

See Also

ftxt_cache, cache_file_info()

Other caching-functions: cache_file_info(), ftxt_cache

Examples

## Not run: 
cache_options_get()
cache_options_set(path = "foobar")
cache_options_get()

# set full path
path <- tempdir()
cache_options_set(full_path = path)
cache_options_get()

## End(Not run)

ropensci/fulltext documentation built on Sept. 12, 2022, 7:57 a.m.