zendown

Access, download and locally cache files deposited on Zenodo easily.

https://github.com/rfsaldanha/zendown

Science Score: 23.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
○
DOI references
✓
Academic publication links
Links to: zenodo.org
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary

Last synced: 9 months ago · JSON representation

Repository

Access, download and locally cache files deposited on Zenodo easily.

Basic Info

Host: GitHub
Owner: rfsaldanha
License: other
Language: R
Default Branch: main
Homepage: https://rfsaldanha.github.io/zendown/
Size: 4.55 MB

Statistics

Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 2

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

Metadata Files

Readme Changelog License

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# zendown



[![R-CMD-check](https://github.com/rfsaldanha/zendown/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rfsaldanha/zendown/actions/workflows/R-CMD-check.yaml)
[![CRAN status](https://www.r-pkg.org/badges/version/zendown)](https://CRAN.R-project.org/package=zendown)


Access, download and locally cache files deposited on Zenodo easily.

## Installation

You can install the stable release from CRAN.

``` r
install.packages("zendown")
library(zendown)
```
Or install the development version of from GitHub:

``` r
# install.packages("remotes")
remotes::install_github("rfsaldanha/zendown")
library(zendown)
```

## Example

```{r}
library(zendown)
```

This [Zenodo deposit](https://zenodo.org/records/10959197) contains RDS files from examples datasets.

First, you need to find the Zenodo deposit code. It is the number that appears on the end of a Zenodo deposit link. The code number also appears on the Zenodo DOI.

```         
https://zenodo.org/records/10959197
```

Deposition code: **10959197**

With the deposit code and the desired file name, you can just access the file with the `zen_file` function.

```{r}
my_iris <- zen_file(deposit_id = 10959197, file_name = "iris.rds") |>
  readRDS()

head(my_iris)
```

The function will create a cache on your machine with all accessed files, avoiding re-downloading them when you access some file again.

## Cache

By default, the cache is stored on a temporary folder that is cleaned when the R session is ended.

To use a persistent cache and other options, [check this article](https://rfsaldanha.github.io/zendown/articles/cache_options.html).

## More examples

```{r}
# https://zenodo.org/records/10848
zen_file(10848, "DOAJ_Soc_Licenses_Correct.csv") |>
  read.csv2() |>
  tibble::tibble() |>
  head()
```

```{r}
# https://zenodo.org/records/10947952
zen_file(10947952, "2m_temperature_max.parquet") |>
  arrow::read_parquet() |>
  tibble::tibble() |>
  head()
```

```{r}
# https://zenodo.org/records/10889682
zen_file(10889682, "total_precipitation_2023-09-01_2023-09-30_day_sum.nc") |>
  terra::rast() |>
  terra::plot(1)
```

## zen4R

To explore the Zenodo API possibilities to problematically store files and other procedures, check the [zen4R](https://github.com/eblondel/zen4R) package.

Owner

Name: Raphael Saldanha
Login: rfsaldanha
Kind: user
Location: Montpellier
Company: Inria

Twitter: rfsaldanhario
Repositories: 5
Profile: https://github.com/rfsaldanha

Geographer, Master's at Public Health (UFJF), PhD at Health Information and Communication. Postdoc at @INRIA.

GitHub Events

Total

Watch event: 1
Push event: 3

Last Year

Watch event: 1
Push event: 3

Issues and Pull Requests

Last synced: over 1 year ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- cran 294 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 3
Total maintainers: 1

cran.r-project.org: zendown

Access Files from 'Zenodo' Deposits

Homepage: https://rfsaldanha.github.io/zendown/
Documentation: http://cran.r-project.org/web/packages/zendown/zendown.pdf
License: MIT + file LICENSE
Latest release: 0.1.0
published about 2 years ago

Versions: 3
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 294 Last month

Rankings

Dependent packages count: 28.0%

Dependent repos count: 36.0%

Average: 49.8%

Downloads: 85.3%

Maintainers (1)

raphael.de-freitas-saldanha@inria.fr