rOpenSci: The hoardr package

Project Status: Active - The project has reached a stable, usable state and is being actively developed. cran checks Build Status codecov.io rstudio mirror downloads cran version

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

dev version

remotes::install_github("ropensci/hoardr")

usage

initialize client

(x <- hoardr::hoard())
#> <hoard> 
#>   path: 
#>   cache path:

set cache path

x$cache_path_set("foobar", type = 'tempdir')
#> [1] "/var/folders/fc/n7g_vrvn0sx_st0p8lxb3ts40000gn/T//RtmpWAAkp3/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] "/var/folders/fc/n7g_vrvn0sx_st0p8lxb3ts40000gn/T//RtmpWAAkp3/R/foobar/foo.txt"

details

x$details()
#> <cached files>
#>   directory: /var/folders/fc/n7g_vrvn0sx_st0p8lxb3ts40000gn/T//RtmpWAAkp3/R/foobar
#> 
#>   file: /foo.txt
#>   size: 0 mb

delete by file name

x$delete("foo.txt")
x$list()
#> character(0)

todo

see issue 1

Meta