Managing Larger Data on a GitHub Repository
Overview
Because larger (> 50 MB) data files cannot easily be committed to git, a different approach is required to manage data associated with an analysis in a GitHub repository. This package provides a simple work-around by allowing larger (up to 2 GB) data files to piggyback on a repository as assets attached to individual GitHub releases. These files are not handled by git in any way, but instead are uploaded, downloaded, or edited directly by calls through the GitHub API. These data files can be versioned manually by creating different releases. This approach works equally well with public or private repositories. Data can be uploaded and downloaded programmatically from scripts. No authentication is required to download data from public repositories.
- Fix bug in
pb_upload()to correctly resolve"latest"tag - if there is no release
tag actually named "latest" it will use the first release from pb_releases(). [#75]
- Make
pb_download()andpb_info()also resolve"latest"similarly: if there
is no release tag named "latest", use first release from pb_releases()
- Updated test coverage to use GHA
- Fixed error handling for
pb_list()for no release. pb_list()now respects the option"piggyback.verbose"- Fix download token handling [#88]
pb_upload()no longer prints out extra newlines [#93]pb_new_release()now warns and exits early instead of failing if a release
already exists. [#95]
- Fixup test issues [#100]
Show all changes in 0.1.5Hide the rest of the changes in 0.1.5
pb_uploadadds a two-second sleep after user creates release [#101]- This is because it takes a few seconds for the GitHub API to register that
the new release has been created
- Adds
piggyback.cacheR option to avoid memoising altogether - Adds
.pb_cache_clear()function to empty the cache more consistently
(internally and externally)
From NEWS.md in the release
Install
Health
- OK13 OK2026-08-05
- NOTE12 OK, 1 NOTE2026-08-01
- OK13 OK2026-06-08
- ERROR12 OK, 1 ERROR2026-06-07
- OK14 OK2026-03-10
Documentation
- Help pages
- 10 (1 internal)includes a package overview page
- Examples that run
- 11%1 run in a plain check · 1 only when donttest examples are enabled (R CMD check --as-cran) · 7 never run
- Exported functions with examples
- 100%
- Documented parameters
- 94%
- Return-value docs
- 56%
- Help pages citing references
- 0%
- alternatives HTML
- piggyback HTML
Downloads
Repository
- PRs merged (all time)
- 93%
- Median days to close, 50 most recently updated closed issues
- 6
- Median days to close, 50 most recently updated closed PRs
- 0
Stars over time
Forks over time
Releases over time
Issues over time
PRs over time
11 development-tooling and community-health practices detected across 7 families in the upstream repository
Checks run against github.com/ropensci/piggyback on 2026-10-22.
The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel
GitHub Pages site last deployed 2019-07-17
Show all practicesHide 3 practices
Dependencies
Installing piggyback adds 27 packages (16 with compiled code, 8.7 MB of source tarballs). Heaviest: fs 1.4 MB, openssl 1.1 MB, jsonlite 1.0 MB.
Show all 18 packagesHide all 18 packages
Code & Tests
People & History
Pick two releases to compare their code metrics.
- RR 4.6.0 released · 2026-04-24
- RR 4.5.0 released · 2025-04-11
- RR 4.4.0 released · 2024-04-24
- 0.1.5Latest
- RR 4.3.0 released · 2023-04-21
- 0.1.4
- 0.1.32022-05-19 · diff ↗
- 0.1.2
- RR 4.2.0 released · 2022-04-22
- 0.1.12021-09-09 · diff ↗
- 0.1.0
- RR 4.1.0 released · 2021-05-18
- RR 4.0.0 released · 2020-04-24
- 0.0.112020-02-25 · diff ↗
- RR 3.6.0 released · 2019-04-26
- 0.0.102019-02-07 · diff ↗
Package metadata
- First published
- 2018-09-30
- Total releases
- 11 / 8 yrs
- License
- GPL-3 OSI
- Download size
- 519 KB
Cite
Cite this package
Run in R for the authors' preferred citation:
citation("piggyback")This package has no citation file, so citation() returns this entry built from DESCRIPTION.
Cite the R Observatory
For a number measured here: a download total, a coverage figure, an archival date.
From data release v2026-10-25, which the citation names so these numbers can be found later. More on citing and the projects behind them.