hoardr v0.5.2

0

Monthly downloads

0th

Percentile

Manage Cached Files

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

hoardr

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

install.packages("hoardr")

dev version

devtools::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] "/var/folders/fc/n7g_vrvn0sx_st0p8lxb3ts40000gn/T//RtmpsvaRsk/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//RtmpsvaRsk/R/foobar/foo.txt"

details

x$details()
#> <cached files>
#>   directory: /var/folders/fc/n7g_vrvn0sx_st0p8lxb3ts40000gn/T//RtmpsvaRsk/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

Functions in hoardr

Name Description
hoard hoardr class
hoardr-package hoardr
No Results!

Vignettes of hoardr

Name
hoardr_vignette.Rmd
No Results!

Last month downloads

Details

Type Package
License MIT + file LICENSE
URL https://github.com/ropensci/hoardr
BugReports https://github.com/ropensci/hoardr/issues
VignetteBuilder knitr
Encoding UTF-8
RoxygenNote 6.1.1
X-schema.org-applicationCategory Data
X-schema.org-keywords caching, data, files, xml, pdf
X-schema.org-isPartOf https://ropensci.org
NeedsCompilation no
Packaged 2018-12-01 23:39:26 UTC; sckott
Repository CRAN
Date/Publication 2018-12-02 00:00:03 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/hoardr)](http://www.rdocumentation.org/packages/hoardr)