diff --git a/DESCRIPTION b/DESCRIPTION index 27be9a7..ea86fc4 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -6,23 +6,27 @@ Description: Suite of tools for managing cached files, targeting 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. -Version: 0.5.2 -Authors@R: c(person("Scott", "Chamberlain", role = c("aut", "cre"), - email = "myrmecocystus@gmail.com")) +Version: 0.5.3 +Authors@R: c(person("Scott", "Chamberlain", role = "aut", + comment = c(ORCID="0000-0003-2542-2202")), + person("Tamás", "Stirling", role = c("ctb", "cre"), + email = "stirling.tamas@gmail.com")) License: MIT + file LICENSE -URL: https://github.com/ropensci/hoardr +URL: https://docs.ropensci.org/hoardr/, + https://github.com/ropensci/hoardr BugReports: https://github.com/ropensci/hoardr/issues VignetteBuilder: knitr Encoding: UTF-8 -Imports: R6 (>= 2.2.0), rappdirs (>= 0.3.1), digest -Suggests: roxygen2 (>= 6.0.1), testthat, knitr, rmarkdown -RoxygenNote: 6.1.1 +Imports: R6, rappdirs, digest +Suggests: testthat, knitr, rmarkdown +RoxygenNote: 7.2.3 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 -Author: Scott Chamberlain [aut, cre] -Maintainer: Scott Chamberlain +Packaged: 2023-01-26 09:34:04 UTC; tamas +Author: Scott Chamberlain [aut] (), + Tamás Stirling [ctb, cre] +Maintainer: Tamás Stirling Repository: CRAN -Date/Publication: 2018-12-02 00:00:03 UTC +Date/Publication: 2023-01-26 16:00:02 UTC diff --git a/LICENSE b/LICENSE index 1d176f7..d99b2f4 100644 --- a/LICENSE +++ b/LICENSE @@ -1,2 +1,2 @@ -YEAR: 2018 +YEAR: 2020 COPYRIGHT HOLDER: Scott Chamberlain diff --git a/MD5 b/MD5 index 6b0f238..789d2af 100644 --- a/MD5 +++ b/MD5 @@ -1,17 +1,17 @@ -eac40f1f0c45e90bc9b489e6c665bd8a *DESCRIPTION -1b96a74f7e95cf508e814ad0c04525e5 *LICENSE +551617189c0080188c416a474d6dd0fe *DESCRIPTION +35bd8606c71dfbfad3ad27387e177ad4 *LICENSE 55e3517dd2332c0fb5592ca86f74e112 *NAMESPACE -95d65fccb03b2f8be3ec46249214b888 *NEWS.md +3dceee2206b78feb2e1566940c60d357 *NEWS.md 093ac5dd5475d363669db3098a2d9b61 *R/details.R 314241f467e46bd99b404feb304f4742 *R/hoard-package.R b90402d7312395ce623b618f1d03c304 *R/hoard_client.R 17abdfb6022ac7441935f0dc9f96cd0a *R/zzz.R -67d351c1361dfcd5692d0ebfe32c3a92 *README.md -2506e1fd013f98af289beaf19eca8574 *build/vignette.rds -f3de7a59f03aa8dc8b6dd12ae2bd0ec0 *inst/doc/hoardr_vignette.R +7f0d2904db6951443f9247374dd360c7 *README.md +e9dfc7af8424b2feee0b749f25e5232e *build/vignette.rds +e7038584fc028220c4d4e02505170880 *inst/doc/hoardr_vignette.R 74d61fc8457e3bfc9f0baeb0f0f7190c *inst/doc/hoardr_vignette.Rmd -f8a50792070027c5fbab4e8f93e01d9d *inst/doc/hoardr_vignette.html -726997c8d7d7a3ec15ad1ce0aae1707e *man/hoard.Rd +7b9c5a8f43f82643761b073e9b0f04ee *inst/doc/hoardr_vignette.html +07f950c569b053595a2a03f56291afcb *man/hoard.Rd fcf35f91e454e1cd172a08f1e22b0490 *man/hoardr-package.Rd b09a16cf2c04000996dab1bbac0443ee *tests/test-all.R 42b93564de72215c55f2cf533234cf81 *tests/testthat/test-HoardClient.R diff --git a/NEWS.md b/NEWS.md index 435c7fd..a2e493d 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,9 +1,19 @@ +hoardr 0.5.3 +============ + +* New maintainer (#17). + + hoardr 0.5.2 ============ ### BUG FIXES -* Important fix: `HoardClient`, called by `hoardr()` function, was storing the cache path in an environment inside the R6 class. If multiple instances of `HoardClient` exist in the same R session, the cache path for any one then affects all others. Fixed by storing as a private variable int he R6 class instead of in an environment (#14) +* Important fix: `HoardClient`, called by `hoardr()` function, was storing the +cache path in an environment inside the R6 class. If multiple instances of +`HoardClient` exist in the same R session, the cache path for any one then +affects all others. Fixed by storing as a private variable int he R6 class +instead of in an environment (#14). hoardr 0.5.0 @@ -11,8 +21,11 @@ hoardr 0.5.0 ### NEW FEATURES -* Gains new method on the `HoardClient` object to check if one or more files exist, returning a data.frame (#10) -* `cache_path_set()` method on `HoardClient` gains new parameter `full_path` to make the base cache path directly with a full path rather than using the three other parameters (`path`, `type`, and `prefix`) (#12) +* Gains new method on the `HoardClient` object to check if one or more files +exist, returning a data.frame (#10). +* `cache_path_set()` method on `HoardClient` gains new parameter `full_path` to +make the base cache path directly with a full path rather than using the three +other parameters (`path`, `type`, and `prefix`) (#12). hoardr 0.2.0 @@ -20,16 +33,16 @@ hoardr 0.2.0 ### CHANGES -* Compliance with CRAN policies about writing to users disk (#6) +* Compliance with CRAN policies about writing to users disk (#6). ### MINOR IMPROVEMENTS -* Improved documentation (#7) +* Improved documentation (#7). ### BUG FIXES -* Change `key()` and `keys()` to use `file=TRUE` (#8) -* Fix R6 import warning (#5) +* Change `key()` and `keys()` to use `file=TRUE` (#8). +* Fix R6 import warning (#5). hoardr 0.1.0 diff --git a/README.md b/README.md index bddfc3b..8686847 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,41 @@ -hoardr -====== + +# hoardr -[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) -[![cran checks](https://cranchecks.info/badges/worst/hoardr)](https://cranchecks.info/pkgs/hoardr) -[![Build Status](https://travis-ci.org/ropensci/hoardr.svg?branch=master)](https://travis-ci.org/ropensci/hoardr) +[![status](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) +[![cran +checks](https://badges.cranchecks.info/worst/hoardr.svg)](https://badges.cranchecks.info/worst/hoardr.svg) +[![R-check](https://github.com/ropensci/hoardr/workflows/R-check/badge.svg)](https://github.com/ropensci/hoardr/actions?query=workflow%3AR-check) [![codecov.io](https://codecov.io/github/ropensci/hoardr/coverage.svg?branch=master)](https://codecov.io/github/ropensci/hoardr?branch=master) -[![rstudio mirror downloads](http://cranlogs.r-pkg.org/badges/hoardr)](https://github.com/metacran/cranlogs.app) -[![cran version](http://www.r-pkg.org/badges/version/hoardr)](https://cran.r-project.org/package=hoardr) - +[![rstudio mirror +downloads](https://cranlogs.r-pkg.org/badges/hoardr)](https://cran.r-project.org/package=hoardr) +[![cran +version](https://www.r-pkg.org/badges/version/hoardr)](https://cran.r-project.org/package=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.]). +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 - -```r +``` r install.packages("hoardr") ``` dev version - -```r -devtools::install_github("ropensci/hoardr") +``` r +remotes::install_github("ropensci/hoardr") ``` - -```r +``` r library(hoardr) ``` @@ -43,8 +43,7 @@ library(hoardr) initialize client - -```r +``` r (x <- hoardr::hoard()) #> #> path: @@ -53,41 +52,36 @@ initialize client set cache path - -```r +``` r x$cache_path_set("foobar", type = 'tempdir') -#> [1] "/var/folders/fc/n7g_vrvn0sx_st0p8lxb3ts40000gn/T//RtmpsvaRsk/R/foobar" +#> [1] "/tmp/RtmpQCahl1/R/foobar" ``` -make the directory if doesn't exist +make the directory if doesn’t exist - -```r +``` r x$mkdir() ``` put a file in the cache - -```r +``` r cat("hello world", file = file.path(x$cache_path_get(), "foo.txt")) ``` list the files - -```r +``` r x$list() -#> [1] "/var/folders/fc/n7g_vrvn0sx_st0p8lxb3ts40000gn/T//RtmpsvaRsk/R/foobar/foo.txt" +#> [1] "/tmp/RtmpQCahl1/R/foobar/foo.txt" ``` details - -```r +``` r x$details() #> -#> directory: /var/folders/fc/n7g_vrvn0sx_st0p8lxb3ts40000gn/T//RtmpsvaRsk/R/foobar +#> directory: /tmp/RtmpQCahl1/R/foobar #> #> file: /foo.txt #> size: 0 mb @@ -95,8 +89,7 @@ x$details() delete by file name - -```r +``` r x$delete("foo.txt") x$list() #> character(0) @@ -108,9 +101,13 @@ see [issue 1](https://github.com/ropensci/hoardr/issues/1) ## Meta -* Please [report any issues or bugs](https://github.com/ropensci/hoardr/issues). -* 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](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. +- Please [report any issues or + bugs](https://github.com/ropensci/hoardr/issues). +- 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](https://github.com/ropensci/hoardr/blob/master/CODE_OF_CONDUCT.md). + By participating in this project you agree to abide by its terms. [![rofooter](https://ropensci.org/public_images/github_footer.png)](https://ropensci.org) diff --git a/build/vignette.rds b/build/vignette.rds index e471683..1bb1ed1 100644 Binary files a/build/vignette.rds and b/build/vignette.rds differ diff --git a/inst/doc/hoardr_vignette.R b/inst/doc/hoardr_vignette.R index e85dee9..44134c3 100644 --- a/inst/doc/hoardr_vignette.R +++ b/inst/doc/hoardr_vignette.R @@ -1,4 +1,4 @@ -## ----echo=FALSE---------------------------------------------------------- +## ----echo=FALSE--------------------------------------------------------------- knitr::opts_chunk$set( comment = "#>", collapse = TRUE, @@ -6,34 +6,34 @@ knitr::opts_chunk$set( message = FALSE ) -## ----eval=FALSE---------------------------------------------------------- +## ----eval=FALSE--------------------------------------------------------------- # install.packages("hoardr") -## ----eval=FALSE---------------------------------------------------------- +## ----eval=FALSE--------------------------------------------------------------- # devtools::install_github(c("ropensci/hoardr")) -## ------------------------------------------------------------------------ +## ----------------------------------------------------------------------------- library("hoardr") -## ------------------------------------------------------------------------ +## ----------------------------------------------------------------------------- (x <- hoardr::hoard()) -## ------------------------------------------------------------------------ +## ----------------------------------------------------------------------------- x$cache_path_set("foobar", type = 'tempdir') -## ------------------------------------------------------------------------ +## ----------------------------------------------------------------------------- x$mkdir() -## ------------------------------------------------------------------------ +## ----------------------------------------------------------------------------- cat("hello world", file = file.path(x$cache_path_get(), "foo.txt")) -## ------------------------------------------------------------------------ +## ----------------------------------------------------------------------------- x$list() -## ------------------------------------------------------------------------ +## ----------------------------------------------------------------------------- x$details() -## ------------------------------------------------------------------------ +## ----------------------------------------------------------------------------- x$delete("foo.txt") x$list() diff --git a/inst/doc/hoardr_vignette.html b/inst/doc/hoardr_vignette.html index f2d056e..9a53f9a 100644 --- a/inst/doc/hoardr_vignette.html +++ b/inst/doc/hoardr_vignette.html @@ -1,28 +1,38 @@ - + - + - + Introduction to the hoardr package - + - + - + + - - - - - + + + + + + +
+ -
+
@@ -1469,13 +1481,13 @@ -