Description
Manage Cached Files.
Description
Suite of tools for managing cached files, targeting use in other R packages. Uses 'rappdirs' for cross-platform paths. Provides utilities to manage cache directories, including targeting files by path or by key; cached directories can be compressed and uncompressed easily to save disk space.
README.md
hoardr
hoard
- manage cached files
Exposes a single R6
object so that when the package is imported in another package for managing cached files, you don’t need to pollute the NAMESPACE with a bunch of functions. (you can always just hoardr::fxn
, but with a single object there are other benefits as well [maintaining state, e.g.]).
install
stable
install.packages("hoardr")
dev version
remotes::install_github("ropensci/hoardr")
library(hoardr)
usage
initialize client
(x <- hoardr::hoard())
#> <hoard>
#> path:
#> cache path:
set cache path
x$cache_path_set("foobar", type = 'tempdir')
#> [1] "/tmp/Rtmp4oqK58/R/foobar"
make the directory if doesn’t exist
x$mkdir()
put a file in the cache
cat("hello world", file = file.path(x$cache_path_get(), "foo.txt"))
list the files
x$list()
#> [1] "/tmp/Rtmp4oqK58/R/foobar/foo.txt"
details
x$details()
#> <cached files>
#> directory: /tmp/Rtmp4oqK58/R/foobar
#>
#> file: /foo.txt
#> size: 0 mb
delete by file name
x$delete("foo.txt")
x$list()
#> character(0)
Meta
- Please report any issues or bugs.
- License: MIT
- Get citation information for
hoardr
in R doingcitation(package = 'hoardr')
- Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.