R
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
R
docs
man
revdep
tests
vignettes
.Rbuildignore
.gitignore
.travis.yml
CONDUCT.md
DESCRIPTION
LICENSE
NAMESPACE
NEWS.md
README.Rmd
README.md
codemeta.json
cran-comments.md
hoard.Rproj

README.md

hoardr

Project Status: Active - The project has reached a stable, usable state and is being actively developed. 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

install.packages("hoardr")

dev version

devtools::install_github("ropensci/hoardr")
library(hoardr)

usage

initialize client

(x <- hoardr::hoard())
#> <hoard> 
#>   path: 
#>   cache path: /var/folders/gs/4khph0xs0436gmd2gdnwsg080000gn/T//RtmpMKopcW/R/stuffthings

set cache path

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

details

x$details()
#> <cached files>
#>   directory: /var/folders/gs/4khph0xs0436gmd2gdnwsg080000gn/T//RtmpMKopcW/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

  • Please report any issues or bugs.
  • License: MIT
  • Get citation information for hoardr in R doing citation(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.

rofooter