Author: Scott Chamberlain
Date: 2017-05-09

# Introduction to the hoardr package

#### Scott Chamberlain

#### 2017-05-09

# hoardr introduction

`hoardr` is a package for managing cached files.

The benefit of using `hoardr` vs. raw `rapddirs` is that `hoardr` exposes an easy to use `R6` class that has variables and functions within it, so you don’t have to import function foo or bar, etc. Just a single object.

You can easily wrap `hoardr` with user facing functions in your own package to manage cached files.

If you find any bugs or have any feature requests get in touch at https://github.com/ropensci/hoardr.

## Install

Stable from CRAN

    install.packages("hoardr")

Dev version

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

    library("hoardr")

## initialize client

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

## set cache path

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

## details

    x$details()
    #> <cached files>
    #>   directory: /var/folders/gs/4khph0xs0436gmd2gdnwsg080000gn/T//RtmpCbi6wT/R/foobar
    #>
    #>   file: /foo.txt
    #>   size: 0 mb

## delete by file name

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