hoardr

Manage cached files

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
1 of 8 committers (12.5%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary

Keywords

caching r r-package rstats

Keywords from Contributors

genome sequenced-genomes proteome ncbi-genbank metagenomics meta-analysis genome-retrieval genome-annotation ensembl-servers database-retrieval

Last synced: 6 months ago · JSON representation

Repository

Manage cached files

Basic Info

Host: GitHub
Owner: ropensci
License: other
Language: R
Default Branch: master
Homepage:
Size: 141 KB

Statistics

Stars: 23
Watchers: 5
Forks: 3
Open Issues: 0
Releases: 7

Topics

caching r r-package rstats

Created about 9 years ago · Last pushed about 1 year ago

Metadata Files

Readme Changelog Contributing License Code of conduct Codemeta

README.Rmd

---
output: github_document
editor_options: 
  chunk_output_type: console
---


```{r echo=FALSE}
knitr::opts_chunk$set(
  warning = FALSE,
  message = FALSE,
  collapse = TRUE,
  comment = "#>"
)
```
# 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://app.codecov.io/github/ropensci/hoardr?branch=master)
[![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.]).

## install

stable

```{r eval=FALSE}
install.packages("hoardr")
```

dev version

```{r eval=FALSE}
remotes::install_github("ropensci/hoardr")
```

```{r}
library(hoardr)
```

## usage

initialize client

```{r}
(x <- hoardr::hoard())
```

set cache path

```{r}
x$cache_path_set("foobar", type = 'tempdir')
```

make the directory if doesn't exist

```{r}
x$mkdir()
```

put a file in the cache

```{r}
cat("hello world", file = file.path(x$cache_path_get(), "foo.txt"))
```

list the files

```{r}
x$list()
```

details

```{r}
x$details()
```

delete by file name

```{r}
x$delete("foo.txt")
x$list()
```

## 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][coc]. By participating in this project you agree to abide by its terms.

[![rofooter](https://ropensci.org/public_images/github_footer.png)](https://ropensci.org)

[coc]: https://github.com/ropensci/hoardr/blob/master/CODE_OF_CONDUCT.md

Owner

Name: rOpenSci
Login: ropensci
Kind: organization
Email: info@ropensci.org
Location: Berkeley, CA

Website: https://ropensci.org/
Twitter: rOpenSci
Repositories: 307
Profile: https://github.com/ropensci

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "hoardr",
  "description": "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.",
  "name": "hoardr: Manage Cached Files",
  "relatedLink": "https://docs.ropensci.org/hoardr/",
  "codeRepository": "https://github.com/ropensci/hoardr",
  "issueTracker": "https://github.com/ropensci/hoardr/issues",
  "license": "https://spdx.org/licenses/MIT",
  "version": "0.5.4",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.4.2 (2024-10-31)",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Comprehensive R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "author": [
    {
      "@type": "Person",
      "givenName": "Scott",
      "familyName": "Chamberlain",
      "@id": "https://orcid.org/0000-0003-2542-2202"
    }
  ],
  "contributor": [
    {
      "@type": "Person",
      "givenName": "Tams",
      "familyName": "Stirling",
      "email": "stirling.tamas@gmail.com"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Tams",
      "familyName": "Stirling",
      "email": "stirling.tamas@gmail.com"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "R6",
      "name": "R6",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=R6"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "rappdirs",
      "name": "rappdirs",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rappdirs"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "digest",
      "name": "digest",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=digest"
    },
    "SystemRequirements": null
  },
  "applicationCategory": "Data",
  "isPartOf": "https://ropensci.org",
  "keywords": [
    "caching",
    "data",
    "files",
    "xml",
    "pdf",
    "r",
    "rstats",
    "r-package"
  ],
  "fileSize": "32.514KB",
  "releaseNotes": "https://github.com/ropensci/hoardr/blob/master/NEWS.md",
  "readme": "https://github.com/ropensci/hoardr/blob/master/README.md",
  "contIntegration": [
    "https://github.com/ropensci/hoardr/actions?query=workflow%3AR-check",
    "https://app.codecov.io/github/ropensci/hoardr?branch=master"
  ],
  "developmentStatus": "https://www.repostatus.org/#active"
}

GitHub Events

Total

Create event: 1
Release event: 1
Issues event: 2
Watch event: 2
Push event: 2
Pull request event: 4

Last Year

Create event: 1
Release event: 1
Issues event: 2
Watch event: 2
Push event: 2
Pull request event: 4

Committers

Last synced: over 2 years ago

All Time

Total Commits: 78
Total Committers: 8
Avg Commits per committer: 9.75
Development Distribution Score (DDS): 0.218

Past Year

Commits: 10
Committers: 4
Avg Commits per committer: 2.5
Development Distribution Score (DDS): 0.5

Top Committers

Name	Email	Commits
Scott Chamberlain	m**s@g**m	61
Tamas Stirling	s**s@g**m	5
steven2249	s**w@b**u	4
Scott Chamberlain	s**t@f**m	2
Tamás Stirling	4**m@u**m	2
Maëlle Salmon	m**n@y**e	2
Adam H. Sparks	a**s@i**m	1
rOpenSci Bot	m**t@g**m	1

Committer Domains (Top 20 + Academic)

fastmail.com: 1 berkeley.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 18
Total pull requests: 12
Average time to close issues: 9 months
Average time to close pull requests: about 8 hours
Total issue authors: 3
Total pull request authors: 3
Average comments per issue: 0.5
Average comments per pull request: 0.5
Merged pull requests: 12
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 1
Pull requests: 4
Average time to close issues: 1 day
Average time to close pull requests: about 7 hours
Issue authors: 1
Pull request authors: 1
Average comments per issue: 0.0
Average comments per pull request: 0.0
Merged pull requests: 4
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

sckott (14)
stitam (3)
maelle (1)

Pull Request Authors

stitam (10)
adamhsparks (1)
stevenysw (1)

Top Labels

Issue Labels

bug (1)

Pull Request Labels

Packages

Total packages: 2
Total downloads:
- cran 3,346 last-month
Total docker downloads: 193,772

Total dependent packages: 16
(may contain duplicates)
Total dependent repositories: 27
(may contain duplicates)
Total versions: 9
Total maintainers: 1

cran.r-project.org: hoardr

Manage Cached Files

Homepage: https://docs.ropensci.org/hoardr/
Documentation: http://cran.r-project.org/web/packages/hoardr/hoardr.pdf
License: MIT + file LICENSE
Latest release: 0.5.5
published about 1 year ago

Versions: 7
Dependent Packages: 12
Dependent Repositories: 27
Downloads: 3,346 Last month
Docker Downloads: 193,772

Rankings

Dependent packages count: 5.0%

Dependent repos count: 5.3%

Downloads: 8.4%

Average: 11.3%

Stargazers count: 11.8%

Forks count: 12.2%

Docker downloads count: 24.9%

Maintainers (1)

stirling.tamas@gmail.com

Last synced: 6 months ago

conda-forge.org: r-hoardr

Homepage: https://github.com/ropensci/hoardr
License: MIT
Latest release: 0.5.2
published almost 7 years ago

Versions: 2
Dependent Packages: 4
Dependent Repositories: 0

Rankings

Dependent packages count: 12.4%

Dependent repos count: 34.0%

Average: 36.5%

Stargazers count: 45.3%

Forks count: 54.2%

Last synced: 6 months ago

Dependencies

DESCRIPTION cran

R6 * imports
digest * imports
rappdirs * imports
knitr * suggests
rmarkdown * suggests
testthat * suggests

.github/workflows/R-check.yml actions

actions/checkout v3 composite
r-lib/actions/check-r-package v2 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite