zip

Platform independent zip compression via miniz

https://github.com/r-lib/zip

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 15 committers (6.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.6%) to scientific vocabulary

Keywords from Contributors

tidy-data csv visualisation date-time curl devtools documentation-tool excel libgit2-library libgit2
Last synced: 10 months ago · JSON representation

Repository

Platform independent zip compression via miniz

Basic Info
Statistics
  • Stars: 90
  • Watchers: 3
  • Forks: 22
  • Open Issues: 20
  • Releases: 14
Created about 9 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog License Code of conduct

README.Rmd

---
output: github_document
---



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

# zip

> Cross-Platform 'zip' Compression


[![R-CMD-check](https://github.com/r-lib/zip/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/zip/actions/workflows/R-CMD-check.yaml)
[![](https://www.r-pkg.org/badges/version/zip)](https://www.r-pkg.org/pkg/zip)
[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/zip)](https://www.r-pkg.org/pkg/zip)
[![Codecov test coverage](https://codecov.io/gh/r-lib/zip/graph/badge.svg)](https://app.codecov.io/gh/r-lib/zip)


## Installation

Stable version:

```{r}
#| eval: false
install.packages("zip")
```

Development version:

```{r}
#| eval: false
pak::pak("r-lib/zip")
```

## Usage

```{r}
#| include: false
#| echo: false
#| results: hide
library(zip)
```

```{r}
library(zip)
```

### Creating ZIP files

`zip()` creates a new ZIP archive. (It overwrites the output file if it
exists.) Simply supply all directories and files that you want to include
in the archive.

It makes sense to change to the top-level directory of the files before
archiving them, so that the files are stored using a relative path name.

```{r}
zip("sources.zip", c("R", "src"))
file.info("sources.zip")
```

Directories are added recursively by default.

`zip_append()` is similar to `zip()`, but it appends files to an existing
ZIP archive.

### Listing ZIP files

`zip_list()` lists files in a ZIP archive. It returns a data frame:

```{r}
zip_list("sources.zip")
```

### Uncompressing ZIP files

`unzip()` uncompresses a ZIP archive:

```{r}
exdir <- tempfile()
unzip("sources.zip", exdir = exdir)
dir(exdir)
```

### Compressing and uncompressing in background processes

You can use the `zip_process()` and  `unzip_process()` functions to
create background zip / unzip processes. These processes were implemented
on top of the `processx::process` class, so they are pollable.

## License

MIT

Owner

  • Name: R infrastructure
  • Login: r-lib
  • Kind: organization

GitHub Events

Total
  • Create event: 4
  • Release event: 2
  • Issues event: 16
  • Watch event: 10
  • Delete event: 1
  • Issue comment event: 16
  • Push event: 33
  • Pull request event: 8
  • Fork event: 3
Last Year
  • Create event: 4
  • Release event: 2
  • Issues event: 16
  • Watch event: 10
  • Delete event: 1
  • Issue comment event: 16
  • Push event: 33
  • Pull request event: 8
  • Fork event: 3

Committers

Last synced: 12 months ago

All Time
  • Total Commits: 276
  • Total Committers: 15
  • Avg Commits per committer: 18.4
  • Development Distribution Score (DDS): 0.134
Past Year
  • Commits: 24
  • Committers: 2
  • Avg Commits per committer: 12.0
  • Development Distribution Score (DDS): 0.042
Top Committers
Name Email Commits
Gábor Csárdi c****r@g****m 239
Gregory Jefferis j****s@g****m 7
Sergio Oller s****r@g****m 5
Maximilian Muecke m****n@g****m 5
Jim Hester j****r@g****m 5
Wes Hinsley w****y@i****k 3
Elliott Sales de Andrade q****t@g****m 3
chainsawriot c****y@g****m 2
jbfagotfede39 j****t@p****m 1
bart1 1****1 1
Will Beasley w****y@h****m 1
Mara Averick m****k@g****m 1
Jeroen Ooms j****s@g****m 1
Dean Attali d****n@a****m 1
Alexander Rosenstock a****k@w****e 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 94
  • Total pull requests: 38
  • Average time to close issues: 5 months
  • Average time to close pull requests: 2 months
  • Total issue authors: 52
  • Total pull request authors: 16
  • Average comments per issue: 2.39
  • Average comments per pull request: 1.58
  • Merged pull requests: 34
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 10
  • Pull requests: 5
  • Average time to close issues: about 15 hours
  • Average time to close pull requests: about 1 hour
  • Issue authors: 4
  • Pull request authors: 2
  • Average comments per issue: 0.8
  • Average comments per pull request: 0.2
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • gaborcsardi (35)
  • bersbersbers (2)
  • msgoussi (2)
  • jeroen (2)
  • dracodoc (2)
  • schuemie (2)
  • AshesITR (2)
  • stefanoborini (2)
  • skeydan (1)
  • cboettig (1)
  • RadioPete24 (1)
  • dovydas88 (1)
  • enricoschumann (1)
  • fsteinhi (1)
  • cstepper (1)
Pull Request Authors
  • gaborcsardi (19)
  • m-muecke (4)
  • zeehio (2)
  • bart1 (2)
  • jefferis (2)
  • QuLogic (1)
  • batpigandme (1)
  • jimhester (1)
  • daattali (1)
  • wibeasley (1)
  • chainsawriot (1)
  • jbfagotfede39 (1)
  • jeroen (1)
  • AshesITR (1)
  • weshinsley (1)
Top Labels
Issue Labels
bug (22) upkeep (9) feature (7) reprex (3) documentation (1)
Pull Request Labels
feature (1)

Packages

  • Total packages: 2
  • Total downloads:
    • cran 405,523 last-month
  • Total docker downloads: 47,336,905
  • Total dependent packages: 82
    (may contain duplicates)
  • Total dependent repositories: 204
    (may contain duplicates)
  • Total versions: 25
  • Total maintainers: 1
cran.r-project.org: zip

Cross-Platform 'zip' Compression

  • Versions: 15
  • Dependent Packages: 73
  • Dependent Repositories: 192
  • Downloads: 405,523 Last month
  • Docker Downloads: 47,336,905
Rankings
Downloads: 0.8%
Dependent repos count: 1.3%
Dependent packages count: 1.3%
Forks count: 4.2%
Stargazers count: 4.6%
Average: 4.9%
Docker downloads count: 17.3%
Maintainers (1)
Last synced: 11 months ago
conda-forge.org: r-zip
  • Versions: 10
  • Dependent Packages: 9
  • Dependent Repositories: 12
Rankings
Dependent packages count: 6.5%
Dependent repos count: 10.2%
Average: 23.0%
Stargazers count: 35.7%
Forks count: 39.5%
Last synced: 11 months ago

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 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
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action 4.1.4 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pr-commands.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/pr-fetch v2 composite
  • r-lib/actions/pr-push v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • R6 * suggests
  • covr * suggests
  • processx * suggests
  • testthat * suggests
  • withr * suggests